Skip to content

start_app_assessment async

start_app_assessment(
    app_arn: Arn,
    app_version: EntityVersion,
    assessment_name: EntityName,
    *,
    config_overrides: Optional[AsyncresiliencehubClientConfig] = None,
    client_token: Optional[ClientToken] = None,
    tags: Optional[TagMap] = None,
) -> StartAppAssessmentResponse

Creates a new application assessment for an application.

Parameters:

  • app_arn (Arn) –

    Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:partition:resiliencehub:region:account:app/app-id. For more information about ARNs, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference guide.

  • app_version (EntityVersion) –

    The version of the application.

  • assessment_name (EntityName) –

    The name for the assessment.

  • client_token (Optional[ClientToken], default: None ) –

    Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.

  • tags (Optional[TagMap], default: None ) –

    Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.

Raises:

  • AccessDeniedException –

    You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.

  • ConflictException –

    This exception occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

  • InternalServerException –

    This exception occurs when there is an internal failure in the Resilience Hub service.

  • ResourceNotFoundException –

    This exception occurs when the specified resource could not be found.

  • ServiceQuotaExceededException –

    This exception occurs when you have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.

  • ThrottlingException –

    This exception occurs when you have exceeded the limit on the number of requests per second.

  • ValidationException –

    This exception occurs when a request is not valid.

  • UnknownServiceError –

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

Source code in docs_src/capo_resiliencehub/_services/async_resiliencehub.py
async def start_app_assessment(
    self,
    app_arn: "capo_resiliencehub.types.arn.Arn",
    app_version: "capo_resiliencehub.types.entity_version.EntityVersion",
    assessment_name: "capo_resiliencehub.types.entity_name.EntityName",
    *,
    config_overrides: Optional[AsyncresiliencehubClientConfig] = None,
    client_token: Optional[
        "capo_resiliencehub.types.client_token.ClientToken"
    ] = None,
    tags: Optional["capo_resiliencehub.types.tag_map.TagMap"] = None,
) -> "capo_resiliencehub.types.start_app_assessment_response.StartAppAssessmentResponse":
    """<p>Creates a new application assessment for an application.</p>

    Args:
        app_arn: <p>Amazon Resource Name (ARN) of the Resilience Hub application. The format for this ARN is: arn:<code>partition</code>:resiliencehub:<code>region</code>:<code>account</code>:app/<code>app-id</code>. For more information about ARNs, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html"> Amazon Resource Names (ARNs)</a> in the <i>Amazon Web Services General Reference</i> guide.</p>
        app_version: <p>The version of the application.</p>
        assessment_name: <p>The name for the assessment.</p>
        client_token: <p>Used for an idempotency token. A client token is a unique, case-sensitive string of up to 64 ASCII characters. You should not reuse the same client token for other API requests.</p>
        tags: <p>Tags assigned to the resource. A tag is a label that you assign to an Amazon Web Services resource. Each tag consists of a key/value pair.</p>

    Raises:
        capo_resiliencehub.errors.access_denied_exception.AccessDeniedException: <p>You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions.</p>
        capo_resiliencehub.errors.conflict_exception.ConflictException: <p>This exception occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.</p>
        capo_resiliencehub.errors.internal_server_exception.InternalServerException: <p>This exception occurs when there is an internal failure in the Resilience Hub service.</p>
        capo_resiliencehub.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception occurs when the specified resource could not be found.</p>
        capo_resiliencehub.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>This exception occurs when you have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.</p>
        capo_resiliencehub.errors.throttling_exception.ThrottlingException: <p>This exception occurs when you have exceeded the limit on the number of requests per second.</p>
        capo_resiliencehub.errors.validation_exception.ValidationException: <p>This exception occurs when a request is not valid.</p>
        capo_resiliencehub.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_resiliencehub.types.start_app_assessment_request.StartAppAssessmentRequest]",
    ) -> AsyncOperationResponse[
        "capo_resiliencehub.types.start_app_assessment_response.StartAppAssessmentResponse"
    ]:
        import capo_resiliencehub._operations.aws_resilience_hub.start_app_assessment

        (
            output,
            http_response,
        ) = await capo_resiliencehub._operations.aws_resilience_hub.start_app_assessment.async_start_app_assessment(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_resiliencehub.types.start_app_assessment_request.StartAppAssessmentRequest",
    ) -> dict[str, Any]:
        import capo_resiliencehub.types.start_app_assessment_request

        return (
            capo_resiliencehub.types.start_app_assessment_request.redact_sensitive(
                input_
            )
        )

    def _redact_output(
        output: "capo_resiliencehub.types.start_app_assessment_response.StartAppAssessmentResponse",
    ) -> dict[str, Any]:
        import capo_resiliencehub.types.start_app_assessment_response

        return (
            capo_resiliencehub.types.start_app_assessment_response.redact_sensitive(
                output
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "StartAppAssessment",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_resiliencehub.types.start_app_assessment_request.StartAppAssessmentRequest = {
        "app_arn": app_arn,
        "app_version": app_version,
        "assessment_name": assessment_name,
    }
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token
    if tags is not None:
        input_["tags"] = tags

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