DeadlineCloud / Client / create_monitor

create_monitor

DeadlineCloud.Client.create_monitor(**kwargs)

Creates an Amazon Web Services Deadline Cloud monitor that you can use to view your farms, queues, and fleets. After you submit a job, you can track the progress of the tasks and steps that make up the job, and then download the job’s results.

See also: AWS API Documentation

Request Syntax

response = client.create_monitor(
    clientToken='string',
    displayName='string',
    identityCenterInstanceArn='string',
    identityCenterRegion='string',
    subdomain='string',
    roleArn='string',
    tags={
        'string': 'string'
    }
)
Parameters:

  • clientToken (string) –

    The unique token which the server uses to recognize retries of the same request.

    This field is autopopulated if not provided.

  • displayName (string) –

    [REQUIRED]

    The name that you give the monitor that is displayed in the Deadline Cloud console.

    Warning

    This field can store any content. Escape or encode this content before displaying it on a webpage or any other system that might interpret the content of this field.

  • identityCenterInstanceArn (string) –

    [REQUIRED]

    The Amazon Resource Name of the IAM Identity Center instance that authenticates monitor users.

  • identityCenterRegion (string) – The AWS region where IAM Identity Center is enabled. Required when Identity Center is in a different region than the monitor.

  • subdomain (string) –

    [REQUIRED]

    The subdomain to use when creating the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.

  • roleArn (string) –

    [REQUIRED]

    The Amazon Resource Name of the IAM role that the monitor uses to connect to Deadline Cloud. Every user that signs in to the monitor using IAM Identity Center uses this role to access Deadline Cloud resources.

  • tags (dict) –

    The tags to add to your monitor. Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'monitorId': 'string',
    'identityCenterApplicationArn': 'string'
}

Response Structure

  • (dict) –

    Mixin that adds an optional ARN field to response structures. Apply to SummaryMixins (flows into Get, Summary, and BatchGet) and Create outputs.

    • monitorId (string) –

      The unique identifier of the monitor.

    • identityCenterApplicationArn (string) –

      The Amazon Resource Name that IAM Identity Center assigns to the monitor.

Exceptions

  • DeadlineCloud.Client.exceptions.AccessDeniedException

  • DeadlineCloud.Client.exceptions.InternalServerErrorException

  • DeadlineCloud.Client.exceptions.ThrottlingException

  • DeadlineCloud.Client.exceptions.ValidationException

  • DeadlineCloud.Client.exceptions.ServiceQuotaExceededException