Skip to content

describe_permission_set_provisioning_status

describe_permission_set_provisioning_status(
    instance_arn: InstanceArn,
    provision_permission_set_request_id: UUId,
    *,
    config_overrides: Optional[SSOAdminClientConfig] = None,
) -> DescribePermissionSetProvisioningStatusResponse

Describes the status for the given permission set provisioning request.

Parameters:

Raises:

Source code in docs_src/capo_sso_admin/_services/sso_admin.py
def describe_permission_set_provisioning_status(
    self,
    instance_arn: "capo_sso_admin.types.instance_arn.InstanceArn",
    provision_permission_set_request_id: "capo_sso_admin.types.uu_id.UUId",
    *,
    config_overrides: Optional[SSOAdminClientConfig] = None,
) -> "capo_sso_admin.types.describe_permission_set_provisioning_status_response.DescribePermissionSetProvisioningStatusResponse":
    """<p>Describes the status for the given permission set provisioning request.</p>

    Args:
        instance_arn: <p>The ARN of the IAM Identity Center instance under which the operation will be executed. For more information about ARNs, see <a href="/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces</a> in the <i>Amazon Web Services General Reference</i>.</p>
        provision_permission_set_request_id: <p>The identifier that is provided by the <a>ProvisionPermissionSet</a> call to retrieve the current status of the provisioning workflow.</p>

    Raises:
        capo_sso_admin.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_sso_admin.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception, or failure with an internal server.</p>
        capo_sso_admin.errors.resource_not_found_exception.ResourceNotFoundException: <p>Indicates that a requested resource is not found.</p>
        capo_sso_admin.errors.throttling_exception.ThrottlingException: <p>Indicates that the principal has crossed the throttling limits of the API operations.</p>
        capo_sso_admin.errors.validation_exception.ValidationException: <p>The request failed because it contains a syntax error.</p>
        capo_sso_admin.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_sso_admin.types.describe_permission_set_provisioning_status_request.DescribePermissionSetProvisioningStatusRequest]",
    ) -> OperationResponse[
        "capo_sso_admin.types.describe_permission_set_provisioning_status_response.DescribePermissionSetProvisioningStatusResponse"
    ]:
        import capo_sso_admin._operations.swb_external_service.describe_permission_set_provisioning_status

        output, http_response = (
            capo_sso_admin._operations.swb_external_service.describe_permission_set_provisioning_status.describe_permission_set_provisioning_status(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribePermissionSetProvisioningStatus"),
    )
    input_: capo_sso_admin.types.describe_permission_set_provisioning_status_request.DescribePermissionSetProvisioningStatusRequest = {
        "instance_arn": instance_arn,
        "provision_permission_set_request_id": provision_permission_set_request_id,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output