get_streaming_session_backup

NimbleStudio.Client.get_streaming_session_backup(**kwargs)

Gets StreamingSessionBackup resource.

Invoke this operation to poll for a streaming session backup while stopping a streaming session.

See also: AWS API Documentation

Request Syntax

response = client.get_streaming_session_backup(
    backupId='string',
    studioId='string'
)

Parameters

• backupId (string) --

  [REQUIRED]

  The ID of the backup.

• studioId (string) --

  [REQUIRED]

  The studio ID.

Return type

dict

Returns

Response Syntax

{
    'streamingSessionBackup': {
        'arn': 'string',
        'backupId': 'string',
        'createdAt': datetime(2015, 1, 1),
        'launchProfileId': 'string',
        'ownedBy': 'string',
        'sessionId': 'string',
        'state': 'CREATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'READY'|'DELETED'|'CREATE_FAILED'|'DELETE_FAILED'|'STOP_IN_PROGRESS'|'START_IN_PROGRESS'|'STOPPED'|'STOP_FAILED'|'START_FAILED',
        'statusCode': 'STREAMING_SESSION_READY'|'STREAMING_SESSION_DELETED'|'STREAMING_SESSION_CREATE_IN_PROGRESS'|'STREAMING_SESSION_DELETE_IN_PROGRESS'|'INTERNAL_ERROR'|'INSUFFICIENT_CAPACITY'|'ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR'|'NETWORK_CONNECTION_ERROR'|'INITIALIZATION_SCRIPT_ERROR'|'DECRYPT_STREAMING_IMAGE_ERROR'|'NETWORK_INTERFACE_ERROR'|'STREAMING_SESSION_STOPPED'|'STREAMING_SESSION_STARTED'|'STREAMING_SESSION_STOP_IN_PROGRESS'|'STREAMING_SESSION_START_IN_PROGRESS'|'AMI_VALIDATION_ERROR',
        'statusMessage': 'string',
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

• (dict) --

  • streamingSessionBackup (dict) --

    Information about the streaming session backup.

    • arn (string) --

      The Amazon Resource Name (ARN) that is assigned to a studio resource and uniquely identifies it. ARNs are unique across all Regions.

    • backupId (string) --

      The ID of the backup.

    • createdAt (datetime) --

      The ISO timestamp in for when the resource was created.

    • launchProfileId (string) --

      The ID of the launch profile which allowed the backups for the streaming session.

    • ownedBy (string) --

      The user ID of the user that owns the streaming session.

    • sessionId (string) --

      The streaming session ID for the StreamingSessionBackup .

    • state (string) --

      The streaming session state.

    • statusCode (string) --

      The status code.

    • statusMessage (string) --

      The status message for the streaming session backup.

    • tags (dict) --

      A collection of labels, in the form of key-value pairs, that apply to this resource.

      • (string) --
        • (string) --

Exceptions

• NimbleStudio.Client.exceptions.ResourceNotFoundException
• NimbleStudio.Client.exceptions.ConflictException
• NimbleStudio.Client.exceptions.ThrottlingException
• NimbleStudio.Client.exceptions.ValidationException
• NimbleStudio.Client.exceptions.AccessDeniedException
• NimbleStudio.Client.exceptions.InternalServerErrorException