ivsrealtime / Client / get_public_key

get_public_key#

ivsrealtime.Client.get_public_key(**kwargs)#

Gets information for the specified public key.

See also: AWS API Documentation

Request Syntax

response = client.get_public_key(
    arn='string'
)
Parameters:

arn (string) –

[REQUIRED]

ARN of the public key for which the information is to be retrieved.

Return type:

dict

Returns:

Response Syntax

{
    'publicKey': {
        'arn': 'string',
        'name': 'string',
        'publicKeyMaterial': 'string',
        'fingerprint': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • publicKey (dict) –

      The public key that is returned.

      • arn (string) –

        Public key ARN.

      • name (string) –

        Public key name.

      • publicKeyMaterial (string) –

        Public key material.

      • fingerprint (string) –

        The public key fingerprint, a short string used to identify or verify the full public key.

      • tags (dict) –

        Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Tagging AWS Resources for details, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no constraints on tags beyond what is documented there.

        • (string) –

          • (string) –

Exceptions

  • ivsrealtime.Client.exceptions.ResourceNotFoundException

  • ivsrealtime.Client.exceptions.ValidationException

  • ivsrealtime.Client.exceptions.AccessDeniedException