Skip to content
AWS for Query.Farm

aws.cloudcontrol.get_resource_request_status

Example SQL Queries

SELECT * FROM
aws.cloudcontrol.get_resource_request_status
WHERE
"request_token" = 'VALUE';

Description

Returns the current status of a resource operation request. For more information, see Tracking the progress of resource operation requests in the Amazon Web Services Cloud Control API User Guide.

Table Definition

Column NameColumn Data Type
request_token Required Input Column

A unique token used to track the progress of the resource operation request.

Request tokens are included in the ProgressEvent type returned by a resource operation request.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

progress_event

Represents the current status of the resource operation request.

STRUCT(
    "type_name" VARCHAR,
    "identifier" VARCHAR,
    "request_token" VARCHAR,
    "operation" VARCHAR,
    "operation_status" VARCHAR,
    "event_time" TIMESTAMP_S,
    "resource_model" VARCHAR,
    "status_message" VARCHAR,
    "error_code" VARCHAR,
    "retry_after" TIMESTAMP_S
)
Show child fields
progress_event.error_code

For requests with a status of FAILED, the associated error code.

For error code definitions, see Handler error codes in the CloudFormation Command Line Interface User Guide for Extension Development.

progress_event.event_time

When the resource operation request was initiated.

progress_event.identifier

The primary identifier for the resource.

In some cases, the resource identifier may be available before the resource operation has reached a status of SUCCESS.

progress_event.operation

The resource operation type.

progress_event.operation_status

The current status of the resource operation request.

  • PENDING: The resource operation hasn't yet started.

  • IN_PROGRESS: The resource operation is currently in progress.

  • SUCCESS: The resource operation has successfully completed.

  • FAILED: The resource operation has failed. Refer to the error code and status message for more information.

  • CANCEL_IN_PROGRESS: The resource operation is in the process of being canceled.

  • CANCEL_COMPLETE: The resource operation has been canceled.

progress_event.request_token

The unique token representing this resource operation request.

Use the RequestToken with GetResourceRequestStatus to return the current status of a resource operation request.

progress_event.resource_model

A JSON string containing the resource model, consisting of each resource property and its current value.

progress_event.retry_after

When to next request the status of this resource operation request.

progress_event.status_message

Any message explaining the current status.

progress_event.type_name

The name of the resource type used in the operation.