QuickSight / Client / start_automation_job

start_automation_job

QuickSight.Client.start_automation_job(**kwargs)

Starts a new job for a specified automation. The job runs the automation with the provided input payload.

See also: AWS API Documentation

Request Syntax

response = client.start_automation_job(
    AwsAccountId='string',
    AutomationGroupId='string',
    AutomationId='string',
    InputPayload='string'
)
Parameters:

  • AwsAccountId (string) –

    [REQUIRED]

    The ID of the Amazon Web Services account that contains the automation.

  • AutomationGroupId (string) –

    [REQUIRED]

    The ID of the automation group that contains the automation to run.

  • AutomationId (string) –

    [REQUIRED]

    The ID of the automation to run.

  • InputPayload (string) – The input payload for the automation job, provided as a JSON string.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'JobId': 'string',
    'Status': 123,
    'RequestId': 'string'
}

Response Structure

  • (dict) –

    • Arn (string) –

      The Amazon Resource Name (ARN) of the automation job.

    • JobId (string) –

      The ID of the automation job that was started.

    • Status (integer) –

      The HTTP status of the request.

    • RequestId (string) –

      The Amazon Web Services request ID for this operation.

Exceptions

  • QuickSight.Client.exceptions.ThrottlingException

  • QuickSight.Client.exceptions.InvalidParameterValueException

  • QuickSight.Client.exceptions.InternalFailureException

  • QuickSight.Client.exceptions.ResourceNotFoundException

  • QuickSight.Client.exceptions.LimitExceededException

  • QuickSight.Client.exceptions.AccessDeniedException