describe_assessment `async` ¶

describe_assessment(
    catalog: Catalog,
    assessment_identifier: AssessmentIdentifier,
    *,
    config_overrides: Optional[AsyncMarketplaceCatalogClientConfig] = None,
    max_results: Optional[DescribeAssessmentMaxResultInteger] = None,
    next_token: Optional[NextToken] = None,
) -> DescribeAssessmentResponse

Returns the metadata and detailed results of a single assessment, including the framework that was evaluated, the overall assessment result, and a paginated list of individual control evaluation results.

To list available assessments before describing one, use the ListAssessments action.

Parameters:

catalog (Catalog) –

The catalog related to the request. Fixed value: AWSMarketplace
assessment_identifier (AssessmentIdentifier) –

The unique identifier of the assessment to describe. You can provide either the assessment ID (for example, assessment-12345) or the full assessment ARN (for example, arn:aws:aws-marketplace:us-east-1::AWSMarketplace/Assessment/assessment-12345).
max_results (Optional[DescribeAssessmentMaxResultInteger], default: None ) –

Specifies the upper limit of ControlAssessment elements returned on a single page. If a value isn't provided, the default value is 50. Valid values range from 1 to 100.
next_token (Optional[NextToken], default: None ) –

The value of the next token, if it exists. null if there are no more results.

Raises:

AccessDeniedException –

Access is denied.

HTTP status code: 403
InternalServiceException –

There was an internal service exception.

HTTP status code: 500
ResourceNotFoundException –

The specified resource wasn't found.

HTTP status code: 404
ThrottlingException –

Too many requests.

HTTP status code: 429
ValidationException –

An error occurred during validation.

HTTP status code: 422
UnknownServiceError –

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

Source code in docs_src/capo_marketplace_catalog/_services/async_marketplace_catalog.py

async def describe_assessment(
    self,
    catalog: "capo_marketplace_catalog.types.catalog.Catalog",
    assessment_identifier: "capo_marketplace_catalog.types.assessment_identifier.AssessmentIdentifier",
    *,
    config_overrides: Optional[AsyncMarketplaceCatalogClientConfig] = None,
    max_results: Optional[
        "capo_marketplace_catalog.types.describe_assessment_max_result_integer.DescribeAssessmentMaxResultInteger"
    ] = None,
    next_token: Optional[
        "capo_marketplace_catalog.types.next_token.NextToken"
    ] = None,
) -> "capo_marketplace_catalog.types.describe_assessment_response.DescribeAssessmentResponse":
    """<p>Returns the metadata and detailed results of a single assessment, including the framework that was evaluated, the overall assessment result, and a paginated list of individual control evaluation results.</p> <p>To list available assessments before describing one, use the <code>ListAssessments</code> action.</p>

    Args:
        catalog: <p>The catalog related to the request. Fixed value: <code>AWSMarketplace</code> </p>
        assessment_identifier: <p>The unique identifier of the assessment to describe. You can provide either the assessment ID (for example, <code>assessment-12345</code>) or the full assessment ARN (for example, <code>arn:aws:aws-marketplace:us-east-1::AWSMarketplace/Assessment/assessment-12345</code>).</p>
        max_results: <p>Specifies the upper limit of <code>ControlAssessment</code> elements returned on a single page. If a value isn't provided, the default value is 50. Valid values range from 1 to 100.</p>
        next_token: <p>The value of the next token, if it exists. <code>null</code> if there are no more results.</p>

    Raises:
        capo_marketplace_catalog.errors.access_denied_exception.AccessDeniedException: <p>Access is denied.</p> <p>HTTP status code: 403</p>
        capo_marketplace_catalog.errors.internal_service_exception.InternalServiceException: <p>There was an internal service exception.</p> <p>HTTP status code: 500</p>
        capo_marketplace_catalog.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource wasn't found.</p> <p>HTTP status code: 404</p>
        capo_marketplace_catalog.errors.throttling_exception.ThrottlingException: <p>Too many requests.</p> <p>HTTP status code: 429</p>
        capo_marketplace_catalog.errors.validation_exception.ValidationException: <p>An error occurred during validation.</p> <p>HTTP status code: 422</p>
        capo_marketplace_catalog.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_marketplace_catalog.types.describe_assessment_request.DescribeAssessmentRequest]",
    ) -> AsyncOperationResponse[
        "capo_marketplace_catalog.types.describe_assessment_response.DescribeAssessmentResponse"
    ]:
        import capo_marketplace_catalog._operations.awsmp_seymour.describe_assessment

        (
            output,
            http_response,
        ) = await capo_marketplace_catalog._operations.awsmp_seymour.describe_assessment.async_describe_assessment(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeAssessment")
    )
    input_: capo_marketplace_catalog.types.describe_assessment_request.DescribeAssessmentRequest = {
        "catalog": catalog,
        "assessment_identifier": assessment_identifier,
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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

describe_assessment async ¶

describe_assessment `async` ¶