Skip to content

list_connector_scan_configurations

list_connector_scan_configurations(
    *,
    config_overrides: Optional[Inspector2ClientConfig] = None,
    aws_config_connector_arns: Optional[AwsConfigConnectorArnList] = None,
    max_results: Optional[ListConnectorScanConfigurationsMaxResults] = None,
    next_token: Optional[ConnectorNextToken] = None,
) -> ListConnectorScanConfigurationsResponse

Lists scan configurations for Amazon Web Services Config connectors. Results are paginated. Use the nextToken parameter to retrieve the next page of results.

Parameters:

  • aws_config_connector_arns (Optional[AwsConfigConnectorArnList], default: None ) –

    The list of Amazon Web Services Config connector ARNs to filter results.

  • max_results (Optional[ListConnectorScanConfigurationsMaxResults], default: None ) –

    The maximum number of results to return in a single call. Valid range is 1 to 50. To retrieve the remaining results, make another request with the nextToken value returned from this request.

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

    A token to use for paginating results. Set this value to null for the first request. For subsequent calls, use the nextToken value returned from the previous request.

Raises:

  • AccessDeniedException –

    You do not have sufficient access to perform this action.

    For Enable, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region.

  • InternalServerException –

    The request has failed due to an internal failure of the Amazon Inspector service.

  • ThrottlingException –

    The limit on the number of requests per second was exceeded.

  • ValidationException –

    The request has failed validation due to missing required fields or having invalid inputs.

  • UnknownServiceError –

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

Examples:

List scan configurations for a specific AWS Config connector

>>> client.list_connector_scan_configurations(aws_config_connector_arns=['arn:aws:config:us-east-1:123456789012:connector/azure/a7bc5463-04ce-4b52-901e-f26f7292a4a7/2fbed4bd-5b95-4947-a751-8defc76ecdae'], max_results=10)
Source code in docs_src/capo_inspector2/_services/inspector2.py
def list_connector_scan_configurations(
    self,
    *,
    config_overrides: Optional[Inspector2ClientConfig] = None,
    aws_config_connector_arns: Optional[
        "capo_inspector2.types.aws_config_connector_arn_list.AwsConfigConnectorArnList"
    ] = None,
    max_results: Optional[
        "capo_inspector2.types.list_connector_scan_configurations_max_results.ListConnectorScanConfigurationsMaxResults"
    ] = None,
    next_token: Optional[
        "capo_inspector2.types.connector_next_token.ConnectorNextToken"
    ] = None,
) -> "capo_inspector2.types.list_connector_scan_configurations_response.ListConnectorScanConfigurationsResponse":
    """<p>Lists scan configurations for Amazon Web Services Config connectors. Results are paginated. Use the <code>nextToken</code> parameter to retrieve the next page of results.</p>

    Args:
        aws_config_connector_arns: <p>The list of Amazon Web Services Config connector ARNs to filter results.</p>
        max_results: <p>The maximum number of results to return in a single call. Valid range is 1 to 50. To retrieve the remaining results, make another request with the <code>nextToken</code> value returned from this request.</p>
        next_token: <p>A token to use for paginating results. Set this value to null for the first request. For subsequent calls, use the <code>nextToken</code> value returned from the previous request.</p>

    Raises:
        capo_inspector2.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p> <p> For <code>Enable</code>, you receive this error if you attempt to use a feature in an unsupported Amazon Web Services Region. </p>
        capo_inspector2.errors.internal_server_exception.InternalServerException: <p>The request has failed due to an internal failure of the Amazon Inspector service.</p>
        capo_inspector2.errors.throttling_exception.ThrottlingException: <p>The limit on the number of requests per second was exceeded.</p>
        capo_inspector2.errors.validation_exception.ValidationException: <p>The request has failed validation due to missing required fields or having invalid inputs.</p>
        capo_inspector2.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        List scan configurations for a specific AWS Config connector

        >>> client.list_connector_scan_configurations(aws_config_connector_arns=['arn:aws:config:us-east-1:123456789012:connector/azure/a7bc5463-04ce-4b52-901e-f26f7292a4a7/2fbed4bd-5b95-4947-a751-8defc76ecdae'], max_results=10)
    """

    def _handler(
        req: "OperationRequest[capo_inspector2.types.list_connector_scan_configurations_request.ListConnectorScanConfigurationsRequest]",
    ) -> OperationResponse[
        "capo_inspector2.types.list_connector_scan_configurations_response.ListConnectorScanConfigurationsResponse"
    ]:
        import capo_inspector2._operations.inspector2.list_connector_scan_configurations

        output, http_response = (
            capo_inspector2._operations.inspector2.list_connector_scan_configurations.list_connector_scan_configurations(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_inspector2.types.list_connector_scan_configurations_request.ListConnectorScanConfigurationsRequest",
    ) -> dict[str, Any]:
        import capo_inspector2.types.list_connector_scan_configurations_request

        return capo_inspector2.types.list_connector_scan_configurations_request.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_inspector2.types.list_connector_scan_configurations_response.ListConnectorScanConfigurationsResponse",
    ) -> dict[str, Any]:
        import capo_inspector2.types.list_connector_scan_configurations_response

        return capo_inspector2.types.list_connector_scan_configurations_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "ListConnectorScanConfigurations",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_inspector2.types.list_connector_scan_configurations_request.ListConnectorScanConfigurationsRequest = {}
    if aws_config_connector_arns is not None:
        input_["aws_config_connector_arns"] = aws_config_connector_arns
    if max_results is not None:
        input_["max_results"] = max_results
    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