AWSDeadlineCloud

{'tags': {'string': 'string'}}

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

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

type clientToken:

string

param clientToken:

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

This field is autopopulated if not provided.

type displayName:

string

param displayName:

[REQUIRED]

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

type identityCenterInstanceArn:

string

param identityCenterInstanceArn:

[REQUIRED]

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

type subdomain:

string

param subdomain:

[REQUIRED]

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

type roleArn:

string

param roleArn:

[REQUIRED]

The Amazon Resource Name (ARN) 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.

type tags:

dict

param tags:

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) --

rtype:

dict

returns:

Response Syntax

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

Response Structure

• (dict) --

  • monitorId (string) --

    The unique identifier of the monitor.

  • identityCenterApplicationArn (string) --

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