EMRContainers / Client / get_managed_endpoint_session_credentials

get_managed_endpoint_session_credentials#

EMRContainers.Client.get_managed_endpoint_session_credentials(**kwargs)#

Generate a session token to connect to a managed endpoint.

See also: AWS API Documentation

Request Syntax

response = client.get_managed_endpoint_session_credentials(
    endpointIdentifier='string',
    virtualClusterIdentifier='string',
    executionRoleArn='string',
    credentialType='string',
    durationInSeconds=123,
    logContext='string',
    clientToken='string'
)
Parameters:

  • endpointIdentifier (string) –

    [REQUIRED]

    The ARN of the managed endpoint for which the request is submitted.

  • virtualClusterIdentifier (string) –

    [REQUIRED]

    The ARN of the Virtual Cluster which the Managed Endpoint belongs to.

  • executionRoleArn (string) –

    [REQUIRED]

    The IAM Execution Role ARN that will be used by the job run.

  • credentialType (string) –

    [REQUIRED]

    Type of the token requested. Currently supported and default value of this field is “TOKEN.”

  • durationInSeconds (integer) – Duration in seconds for which the session token is valid. The default duration is 15 minutes and the maximum is 12 hours.

  • logContext (string) – String identifier used to separate sections of the execution logs uploaded to S3.

  • clientToken (string) –

    The client idempotency token of the job run request.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'id': 'string',
    'credentials': {
        'token': 'string'
    },
    'expiresAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • id (string) –

      The identifier of the session token returned.

    • credentials (dict) –

      The structure containing the session credentials.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: token. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}

      • token (string) –

        The actual session token being returned.

    • expiresAt (datetime) –

      The date and time when the session token will expire.

Exceptions

  • EMRContainers.Client.exceptions.ValidationException

  • EMRContainers.Client.exceptions.RequestThrottledException

  • EMRContainers.Client.exceptions.ResourceNotFoundException

  • EMRContainers.Client.exceptions.InternalServerException