Skip to content

describe_report_creation async

describe_report_creation(
    *, config_overrides: Optional[AsyncResourceGroupsTaggingAPIClientConfig] = None
) -> DescribeReportCreationOutput

Describes the status of the StartReportCreation operation.

You can call this operation only from the organization's management account and from the us-east-1 Region.

Raises:

  • ConstraintViolationException –

    The request failed because performing the operation would violate a constraint.

    Some of the reasons in the following list might not apply to this specific operation.

    • You must meet the prerequisites for using tag policies. For information, see Prerequisites and permissions in the Tagging Amazon Web Services resources and Tag Editor user guide.

    • You must enable the tag policies service principal (tagpolicies.tag.amazonaws.com) to integrate with Organizations For information, see EnableAWSServiceAccess.

    • You must have a tag policy attached to the organization root, an OU, or an account.

  • InternalServiceException –

    The request processing failed because of an unknown error, exception, or failure. You can retry the request.

  • InvalidParameterException –

    The request failed because of one of the following reasons:

    • A required parameter is missing.

    • A provided string parameter is malformed.

    • An provided parameter value is out of range.

    • The target ID is invalid, unsupported, or doesn't exist.

    • You can't access the Amazon S3 bucket for report storage. For more information, see Amazon S3 bucket policy for report storage in the Tagging Amazon Web Services resources and Tag Editor user guide.

    • The partition specified in an ARN parameter in the request doesn't match the partition where you invoked the operation. The partition is specified by the second field of the ARN.

  • ThrottledException –

    The request failed because it exceeded the allowed frequency of submitted requests.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_resource_groups_tagging_api/_services/async_resource_groups_tagging_api.py
async def describe_report_creation(
    self,
    *,
    config_overrides: Optional[AsyncResourceGroupsTaggingAPIClientConfig] = None,
) -> "capo_resource_groups_tagging_api.types.describe_report_creation_output.DescribeReportCreationOutput":
    """<p>Describes the status of the <code>StartReportCreation</code> operation. </p> <p>You can call this operation only from the organization's management account and from the us-east-1 Region.</p>

    Raises:
        capo_resource_groups_tagging_api.errors.constraint_violation_exception.ConstraintViolationException: <p>The request failed because performing the operation would violate a constraint.</p> <p>Some of the reasons in the following list might not apply to this specific operation.</p> <ul> <li> <p>You must meet the prerequisites for using tag policies. For information, see <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/tag-policies-orgs.html#tag-policies-prereqs">Prerequisites and permissions</a> in the <i>Tagging Amazon Web Services resources and Tag Editor</i> user guide. </p> </li> <li> <p>You must enable the tag policies service principal (<code>tagpolicies.tag.amazonaws.com</code>) to integrate with Organizations For information, see <a href="https://docs.aws.amazon.com/organizations/latest/APIReference/API_EnableAWSServiceAccess.html">EnableAWSServiceAccess</a>.</p> </li> <li> <p>You must have a tag policy attached to the organization root, an OU, or an account.</p> </li> </ul>
        capo_resource_groups_tagging_api.errors.internal_service_exception.InternalServiceException: <p>The request processing failed because of an unknown error, exception, or failure. You can retry the request.</p>
        capo_resource_groups_tagging_api.errors.invalid_parameter_exception.InvalidParameterException: <p>The request failed because of one of the following reasons:</p> <ul> <li> <p>A required parameter is missing.</p> </li> <li> <p>A provided string parameter is malformed.</p> </li> <li> <p>An provided parameter value is out of range.</p> </li> <li> <p>The target ID is invalid, unsupported, or doesn't exist.</p> </li> <li> <p>You can't access the Amazon S3 bucket for report storage. For more information, see <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/tag-policies-orgs.html#bucket-policy">Amazon S3 bucket policy for report storage</a> in the <i>Tagging Amazon Web Services resources and Tag Editor</i> user guide. </p> </li> <li> <p>The partition specified in an ARN parameter in the request doesn't match the partition where you invoked the operation. The partition is specified by the second field of the ARN.</p> </li> </ul>
        capo_resource_groups_tagging_api.errors.throttled_exception.ThrottledException: <p>The request failed because it exceeded the allowed frequency of submitted requests.</p>
        capo_resource_groups_tagging_api.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_resource_groups_tagging_api.types.describe_report_creation_input.DescribeReportCreationInput]",
    ) -> AsyncOperationResponse[
        "capo_resource_groups_tagging_api.types.describe_report_creation_output.DescribeReportCreationOutput"
    ]:
        import capo_resource_groups_tagging_api._operations.resource_groups_tagging_api_20170126.describe_report_creation

        (
            output,
            http_response,
        ) = await capo_resource_groups_tagging_api._operations.resource_groups_tagging_api_20170126.describe_report_creation.async_describe_report_creation(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeReportCreation")
    )
    input_: capo_resource_groups_tagging_api.types.describe_report_creation_input.DescribeReportCreationInput = {}

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output