Skip to content

describe_conformance_pack_status

describe_conformance_pack_status(
    *,
    config_overrides: Optional[ConfigServiceClientConfig] = None,
    conformance_pack_names: Optional[ConformancePackNamesList] = None,
    limit: Optional[PageSizeLimit] = None,
    next_token: Optional[NextToken] = None,
) -> DescribeConformancePackStatusResponse

Provides one or more conformance packs deployment status.

If there are no conformance packs then you will see an empty result.

Parameters:

  • conformance_pack_names (Optional[ConformancePackNamesList], default: None ) –

    Comma-separated list of conformance pack names.

  • limit (Optional[PageSizeLimit], default: None ) –

    The maximum number of conformance packs status returned on each page.

  • next_token (Optional[NextToken], default: None ) –

    The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

Raises:

  • InvalidLimitException –

    The specified limit is outside the allowable range.

  • InvalidNextTokenException –

    The specified next token is not valid. Specify the nextToken string that was returned in the previous response to get the next page of results.

  • InvalidParameterValueException –

    One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.

  • UnknownServiceError –

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

Source code in docs_src/capo_config_service/_services/config_service.py
def describe_conformance_pack_status(
    self,
    *,
    config_overrides: Optional[ConfigServiceClientConfig] = None,
    conformance_pack_names: Optional[
        "capo_config_service.types.conformance_pack_names_list.ConformancePackNamesList"
    ] = None,
    limit: Optional[
        "capo_config_service.types.page_size_limit.PageSizeLimit"
    ] = None,
    next_token: Optional["capo_config_service.types.next_token.NextToken"] = None,
) -> "capo_config_service.types.describe_conformance_pack_status_response.DescribeConformancePackStatusResponse":
    """<p>Provides one or more conformance packs deployment status.</p> <note> <p>If there are no conformance packs then you will see an empty result.</p> </note>

    Args:
        conformance_pack_names: <p>Comma-separated list of conformance pack names.</p>
        limit: <p>The maximum number of conformance packs status returned on each page.</p>
        next_token: <p>The <code>nextToken</code> string returned in a previous request that you use to request the next page of results in a paginated response.</p>

    Raises:
        capo_config_service.errors.invalid_limit_exception.InvalidLimitException: <p>The specified limit is outside the allowable range.</p>
        capo_config_service.errors.invalid_next_token_exception.InvalidNextTokenException: <p>The specified next token is not valid. Specify the <code>nextToken</code> string that was returned in the previous response to get the next page of results.</p>
        capo_config_service.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.</p>
        capo_config_service.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_config_service.types.describe_conformance_pack_status_request.DescribeConformancePackStatusRequest]",
    ) -> OperationResponse[
        "capo_config_service.types.describe_conformance_pack_status_response.DescribeConformancePackStatusResponse"
    ]:
        import capo_config_service._operations.starling_dove_service.describe_conformance_pack_status

        output, http_response = (
            capo_config_service._operations.starling_dove_service.describe_conformance_pack_status.describe_conformance_pack_status(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeConformancePackStatus")
    )
    input_: capo_config_service.types.describe_conformance_pack_status_request.DescribeConformancePackStatusRequest = {}
    if conformance_pack_names is not None:
        input_["conformance_pack_names"] = conformance_pack_names
    if limit is not None:
        input_["limit"] = limit
    if next_token is not None:
        input_["next_token"] = next_token

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