Pyjo.AWS.Protocol.RestJSON - Call of the REST-JSON protocol of AWS¶
from Pyjo.AWS.Client import Client
from Pyjo.AWS.Protocol.RestJSON import RestJSON
layers = Client(service='lambda').call(RestJSON('GET', '/2018-10-31/layers', query={'MaxItems': 50}))
print([layer['LayerName'] for layer in layers['Layers']])
# Or import the module, as in Google Python Style Guide
import Pyjo.AWS.Client
import Pyjo.AWS.Protocol.RestJSON
lambda_ = Pyjo.AWS.Client.new(service='lambda', region='eu-central-1')
call = Pyjo.AWS.Protocol.RestJSON.new('POST', '/2015-03-31/functions/hello/invocations', {'name': 'World'})
lambda_.call_p(call).then(lambda result: print(result)).wait()
Pyjo.AWS.Protocol.RestJSON is a call of the REST-JSON protocol of
AWS, of the APIs of Lambda, SSO, API Gateway, EKS, Glacier and others: a
method and a path, which is percent-encoded already, with the parameters of
its query, its headers and the JSON of its body. The result is the JSON of
the response, its body of another type, or None without a body.
The error of the response is the code of the header X-Amzn-ErrorType or
of the field code or __type, and the message of the field
message.
See also¶
Pyjo.AWS.Protocol, Pyjo.AWS.Client,
https://smithy.io/2.0/aws/protocols/aws-restjson1-protocol.html.
Classes¶
- class Pyjo.AWS.Protocol.RestJSON.Pyjo_AWS_Protocol_RestJSON(method: str, path: str, json: Any = None, *, query: Mapping[str, Any] | None = None, headers: Mapping[str, str] | None = None)[source]¶
Pyjo.AWS.Protocol.RestJSONinherits all attributes and methods fromPyjo.AWS.Protocoland implements the following new ones.- __init__(method: str, path: str, json: Any = None, *, query: Mapping[str, Any] | None = None, headers: Mapping[str, str] | None = None) None[source]¶
call = Pyjo.AWS.Protocol.RestJSON.new('GET', '/2018-10-31/layers') call = Pyjo.AWS.Protocol.RestJSON.new('GET', '/federation/credentials', query={'role_name': 'admin', 'account_id': '123456789012'}, headers={'X-Amz-Sso_bearer_token': token}) call = Pyjo.AWS.Protocol.RestJSON.new('POST', '/2018-10-31/layers/hello/versions', {'Content': content})
Construct a new
Pyjo.AWS.Protocol.RestJSONobject.
- build_tx(ua: Pyjo_UserAgent, url: Pyjo_URL) Pyjo_Transaction_HTTP[source]¶
tx = call.build_tx(ua, url)
The transaction of the method and the path, after the path of the endpoint, with the JSON of the body.
- error(tx: Pyjo_Transaction_HTTP) Pyjo_AWS_Error[source]¶
e = call.error(tx)
The error of the JSON of the response.
- headers¶
headers = call.headers
The headers of the request.
- json¶
json = call.json
The JSON of the body of the request, or
Nonefor none.
- method¶
method = call.method
The method of the request, as
GET.
- parse(tx: Pyjo_Transaction_HTTP) Any[source]¶
result = call.parse(tx)
The JSON of the response, its body of a type that is not JSON, or
Nonewithout a body.
- path¶
path = call.path
The path of the request, which is percent-encoded already, as
/2018-10-31/layers/hello%2Dworld/versions, with the parameters of a query too.
- query¶
query = call.query
The parameters of the query, whose values are strings,
trueorfalseof booleans and the strings of the others, whoseNonevalues the request leaves out.