sdkagent

aws-crt-python API reference

130 public APIs from aws-crt-python (awslabs/aws-crt-python) — 74 classes, 10 functions, 46 methods. Signatures extracted by static analysis of the actual source.

Repository: awslabs/aws-crt-python

KindCount
Classes74
Functions10
Methods46

API list

classawscrt.NativeResource
Base for classes that bind to a native type.
classawscrt.aio.http.AIOHttp2ClientConnection
An async HTTP/2 only client connection.
methodawscrt.aio.http.AIOHttp2ClientConnection.update_window(increment_size:int) -> None
Update the connection's flow control window.
classawscrt.aio.http.AIOHttp2ClientStream
HTTP/2 stream that sends a request and receives a response.
classawscrt.aio.http.AIOHttpClientConnection
An async HTTP/1.1 only client connection.
classawscrt.auth.AwsSignatureType
Which sort of signature should be computed from the signable.
classawscrt.auth.AwsSigningAlgorithm
AWS signing algorithm enumeration.
classawscrt.auth.AwsSigningConfig
Configuration for use in AWS-related signing.
funcawscrt.auth.aws_sign_request(http_request, signing_config)
Perform AWS HTTP request signing.
classawscrt.aws_iot_metrics.IoTMetricsMetadata
A key-value pair for IoT SDK metrics metadata.
classawscrt.cbor.AwsCborType
CBOR data type enumeration.
funcawscrt.checksums.crc32(input:bytes, previous_crc32:int=0) -> int
Perform a CRC32 (Ethernet, gzip) computation.
funcawscrt.checksums.crc32c(input:bytes, previous_crc32c:int=0) -> int
Perform a Castagnoli CRC32c (iSCSI) computation.
funcawscrt.checksums.crc64nvme(input:bytes, previous_crc64nvme:int=0) -> int
Perform a CRC64 NVME computation.
funcawscrt.common.get_cpu_count_for_group(group_idx:int) -> int
Returns number of processors in a given group.
funcawscrt.common.get_cpu_group_count() -> int
Returns number of processor groups on the system.
funcawscrt.common.join_all_native_threads(*timeout_sec:float=-1.0) -> bool
Waits for all native threads to complete their join call.
methodawscrt.crypto.EC.decode_der_signature(signature:bytes) -> ECRawSignature
Decodes ec signature into raw r and s.
methodawscrt.crypto.EC.decode_der_signature_to_padded_pair(signature:bytes, pad_to:int) -> bytes
Decodes ec signature into padded r || s.
methodawscrt.crypto.EC.encode_raw_signature(signature:ECRawSignature) -> bytes
Encodes raw signature into der.
methodawscrt.crypto.EC.export_key(export_format:ECExportFormat) -> bytes
Exports the key in specified format.
methodawscrt.crypto.EC.get_public_coords() -> ECPublicCoords
Get public coords of the key
methodawscrt.crypto.EC.new_generate(type:ECType) -> 'EC'
Generates a new instance of EC key pair.
methodawscrt.crypto.EC.new_key_from_der_data(der_data:Union[bytes, bytearray, memoryview]) -> 'EC'
Creates a new instance of EC key pair from der data.
methodawscrt.crypto.EC.sign(digest:Union[bytes, bytearray, memoryview]) -> bytes
Signs data using a given algorithm.
methodawscrt.crypto.EC.verify(digest:Union[bytes, bytearray, memoryview], signature:Union[bytes, bytearray, memoryview]) -> bool
Verifies signature against digest.
classawscrt.crypto.ECExportFormat
EC Export format
classawscrt.crypto.ECType
Elliptic Curve Type
classawscrt.crypto.ED25519ExportFormat
ED25519 Export format
methodawscrt.crypto.RSA.decrypt(encryption_algorithm:RSAEncryptionAlgorithm, ciphertext:Union[bytes, bytearray, memoryview]) -> bytes
Decrypts data using a given algorithm.
methodawscrt.crypto.RSA.encrypt(encryption_algorithm:RSAEncryptionAlgorithm, plaintext:Union[bytes, bytearray, memoryview]) -> bytes
Encrypts data using a given algorithm.
methodawscrt.crypto.RSA.sign(signature_algorithm:RSASignatureAlgorithm, digest:Union[bytes, bytearray, memoryview]) -> bytes
Signs data using a given algorithm.
methodawscrt.crypto.RSA.verify(signature_algorithm:RSASignatureAlgorithm, digest:Union[bytes, bytearray, memoryview], signature:Union[bytes, bytearray, memoryview]) -> bool
Verifies signature against digest.
classawscrt.crypto.RSAEncryptionAlgorithm
RSA Encryption Algorithm
classawscrt.crypto.RSASignatureAlgorithm
RSA Encryption Algorithm
classawscrt.eventstream.Header
A header in an event-stream message.
methodawscrt.eventstream.Header.from_string(name:str, value:str) -> 'Header'
Create a Header of type :attr:`~HeaderType.STRING`
methodawscrt.eventstream.Header.name() -> str
Header name
methodawscrt.eventstream.Header.type() -> HeaderType
Header type
methodawscrt.eventstream.Header.value() -> Any
Header value The header's type determines the value's type.
classawscrt.eventstream.HeaderType
Supported types for the value within a Header
classawscrt.eventstream.rpc.ClientConnection
A client connection for the event-stream RPC protocol.
methodawscrt.eventstream.rpc.ClientConnection.close()
Close the connection.
methodawscrt.eventstream.rpc.ClientConnection.new_stream(handler:'ClientContinuationHandler') -> 'ClientContinuation'
Create a new stream.
classawscrt.eventstream.rpc.ClientConnectionHandler
Base class for handling connection events.
methodawscrt.eventstream.rpc.ClientConnectionHandler.on_connection_shutdown(reason:Optional[Exception], **kwargs) -> None
Invoked when the connection finishes shutting down.
classawscrt.eventstream.rpc.ClientContinuation
A continuation of messages on a given stream-id.
classawscrt.eventstream.rpc.ClientContinuationHandler
Base class for handling stream continuation events.
methodawscrt.eventstream.rpc.ClientContinuationHandler.on_continuation_closed(**kwargs) -> None
Invoked when the continuation is closed.
classawscrt.eventstream.rpc.MessageFlag
Flags for messages in the event-stream RPC protocol.
classawscrt.eventstream.rpc.MessageType
Types of messages in the event-stream RPC protocol.
classawscrt.exceptions.AwsCrtError
Base exception class for AWS Common Runtime exceptions.
classawscrt.http.Http2Setting
HTTP/2 Setting.
classawscrt.http.Http2SettingID
HTTP/2 Predefined settings(RFC-9113 6.5.2).
classawscrt.http.HttpClientConnection
An HTTP client connection.
methodawscrt.http.HttpClientConnection.close() -> 'concurrent.futures.Future'
Close the connection.
classawscrt.http.HttpClientStream
HTTP stream that sends a request and receives a response.
methodawscrt.http.HttpClientStream.activate() -> None
Begin sending the request.
classawscrt.http.HttpClientStreamBase
Base for HTTP client stream classes.
methodawscrt.http.HttpClientStreamBase.response_status_code() -> Optional[int]
int: The response status code.
methodawscrt.http.HttpClientStreamBase.update_window(increment_size:int) -> None
Update the stream's flow control window.
methodawscrt.http.HttpClientStreamBase.version() -> HttpVersion
HttpVersion: Protocol used by this stream
classawscrt.http.HttpConnectionBase
Base for HTTP connection classes.
methodawscrt.http.HttpConnectionBase.version() -> HttpVersion
HttpVersion: Protocol used by this connection
classawscrt.http.HttpHeaders
Collection of HTTP headers.
methodawscrt.http.HttpHeaders.add(name:str, value:str) -> None
Add a name-value pair.
methodawscrt.http.HttpHeaders.add_pairs(name_value_pairs:List[Tuple[str, str]]) -> None
Add list of (name,value) pairs.
methodawscrt.http.HttpHeaders.clear() -> None
Clear all headers.
methodawscrt.http.HttpHeaders.get_values(name:str) -> Iterator[str]
Return an iterator over the values for this name.
methodawscrt.http.HttpHeaders.remove(name:str) -> None
Remove all values for this name.
methodawscrt.http.HttpHeaders.remove_value(name:str, value:str) -> None
Remove a specific value for this name.
methodawscrt.http.HttpHeaders.set(name:str, value:str) -> None
Set a name-value pair, any existing values for the name are removed.
classawscrt.http.HttpMessageBase
Base for HttpRequest and HttpResponse classes.
methodawscrt.http.HttpMessageBase.headers() -> 'HttpHeaders'
HttpHeaders: Headers to send.
classawscrt.http.HttpProxyAuthenticationType
Proxy authentication type enumeration.
classawscrt.http.HttpProxyConnectionType
Proxy connection type enumeration
classawscrt.http.HttpProxyOptions
Proxy options for HTTP clients.
classawscrt.http.HttpRequest
Definition for an outgoing HTTP request.
methodawscrt.http.HttpRequest.method() -> str
str: HTTP request method (verb).
methodawscrt.http.HttpRequest.path() -> str
str: HTTP path-and-query value.
classawscrt.http.HttpStreamBase
Base for HTTP stream classes.
classawscrt.http.HttpVersion
HTTP protocol version enumeration
classawscrt.io.ClientBootstrap
Handles creation and setup of client socket connections.
classawscrt.io.ClientTlsContext
Client TLS context.
classawscrt.io.DefaultHostResolver
Default DNS host resolver.
classawscrt.io.EventLoopGroup
A collection of event-loops.
classawscrt.io.HostResolverBase
DNS host resolver.
classawscrt.io.Pkcs11Lib
Handle to a loaded PKCS#11 library.
classawscrt.io.Pkcs11Lib.InitializeFinalizeBehavior
An enumeration.
classawscrt.io.SocketOptions
Socket options.
classawscrt.io.TlsCipherPref
TLS Cipher Preference.
classawscrt.io.TlsConnectionOptions
Connection-specific TLS options.
methodawscrt.io.TlsConnectionOptions.set_server_name(server_name)
Set server name.
classawscrt.io.TlsContextOptions
Options to create a TLS context.
methodawscrt.io.TlsContextOptions.override_default_trust_store(rootca_buffer)
Override default trust store.
funcawscrt.io.init_logging(log_level, file_name)
Initialize logging in `awscrt`.
funcawscrt.io.set_log_level(log_level)
Change the log level of `awscrt`.
classawscrt.logging.LogSubject
Log subject identifiers for CRT subsystems.
funcawscrt.logging.set_log_level(level:int)
Change the CRT log level.
classawscrt.mqtt.Client
MQTT client.
classawscrt.mqtt.ConnectReturnCode
Connect return code enumeration.
classawscrt.mqtt.Connection
MQTT client connection.
methodawscrt.mqtt.Connection.disconnect()
Close the connection (async).
methodawscrt.mqtt.Connection.publish(topic, payload, qos, retain=False)
Publish message (async).
methodawscrt.mqtt.Connection.reconnect()
DEPRECATED.
classawscrt.mqtt.QoS
Quality of Service enumeration [MQTT-4.3]
classawscrt.mqtt.SubscribeError
Subscription rejected by server.
classawscrt.mqtt.WebsocketHandshakeTransformArgs
Argument to a "websocket_handshake_transform" function.
classawscrt.mqtt5.ConnectReasonCode
Server return code for connect attempts.
classawscrt.mqtt5.DisconnectReasonCode
Reason code inside DISCONNECT packets.
classawscrt.mqtt5.PayloadFormatIndicator
Optional property describing a PUBLISH payload's format.
classawscrt.mqtt5.QoS
MQTT message delivery quality of service.
classawscrt.mqtt5.RetainAndHandlingType
DEPRECATED.
classawscrt.mqtt5.SubackReasonCode
Reason code inside SUBACK packet payloads.
classawscrt.mqtt5.TopicAliasingOptions
Configuration for all client topic aliasing behavior.
classawscrt.mqtt5.WebsocketHandshakeTransformArgs
Argument to a "websocket_handshake_transform" function.
classawscrt.s3.S3ChecksumAlgorithm
Checksum algorithm used to verify object integrity.
classawscrt.s3.S3ChecksumLocation
Where to put the checksum.
classawscrt.s3.S3RequestTlsMode
TLS mode for S3 request
classawscrt.s3.S3RequestType
The type of the AWS S3 request
classawscrt.s3.S3ResponseError
An error response from S3.
classawscrt.websocket.IncomingFrame
Describes the frame you are receiving.
methodawscrt.websocket.IncomingFrame.is_data_frame()
True if this is a "data frame".
classawscrt.websocket.OnConnectionSetupData
Data passed to the `on_connection_setup` callback
classawscrt.websocket.OnConnectionShutdownData
Data passed to the `on_connection_shutdown` callback
classawscrt.websocket.OnIncomingFrameBeginData
Data passed to the `on_incoming_frame_begin` callback.
classawscrt.websocket.Opcode
An opcode defines a frame's type.
methodawscrt.websocket.Opcode.is_data_frame()
True if this is a "data frame" opcode.
classawscrt.websocket.WebSocket
A WebSocket connection.
methodawscrt.websocket.WebSocket.close()
Close the WebSocket asynchronously.

About this data

These signatures were extracted from the public source of awslabs/aws-crt-python using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries