ivsrealtime / Client / import_public_key

import_public_key#

ivsrealtime.Client.import_public_key(**kwargs)#

Import a public key to be used for signing stage participant tokens.

See also: AWS API Documentation

Request Syntax

response = client.import_public_key(
    publicKeyMaterial='string',
    name='string',
    tags={
        'string': 'string'
    }
)
Parameters:

  • publicKeyMaterial (string) –

    [REQUIRED]

    The content of the public key to be imported.

  • name (string) – Name of the public key to be imported.

  • tags (dict) –

    Tags attached to the resource. Array of maps, each of the form string:string (key:value). See Best practices and strategies in Tagging AWS Resources and Tag Editor 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) –

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 was imported.

      • 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 Best practices and strategies in Tagging AWS Resources and Tag Editor 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