get_configuration ¶

get_configuration(
    *,
    config_overrides: Optional[Inspector2ClientConfig] = None,
    account_id: Optional[AccountId] = None,
) -> GetConfigurationResponse

Retrieves setting configurations for Amazon Inspector scans. If you specify an accountId, this operation returns the scan configuration for that member account. You must be the delegated administrator for the specified member account. If you do not specify an accountId, this operation returns your own scan configuration.

Parameters:

account_id (Optional[AccountId], default: None ) –

The 12-digit Amazon Web Services account ID of the member account whose scan configuration you want to retrieve. When specified, you must be the delegated administrator for this member account. If not specified, the operation returns your own configuration.

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.
ResourceNotFoundException –

The operation tried to access an invalid resource. Make sure the resource is specified correctly.
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.

Source code in docs_src/capo_inspector2/_services/inspector2.py

def get_configuration(
    self,
    *,
    config_overrides: Optional[Inspector2ClientConfig] = None,
    account_id: Optional["capo_inspector2.types.account_id.AccountId"] = None,
) -> "capo_inspector2.types.get_configuration_response.GetConfigurationResponse":
    """<p>Retrieves setting configurations for Amazon Inspector scans. If you specify an <code>accountId</code>, this operation returns the scan configuration for that member account. You must be the delegated administrator for the specified member account. If you do not specify an <code>accountId</code>, this operation returns your own scan configuration.</p>

    Args:
        account_id: <p>The 12-digit Amazon Web Services account ID of the member account whose scan configuration you want to retrieve. When specified, you must be the delegated administrator for this member account. If not specified, the operation returns your own configuration.</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.resource_not_found_exception.ResourceNotFoundException: <p>The operation tried to access an invalid resource. Make sure the resource is specified correctly.</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.
    """

    def _handler(
        req: "OperationRequest[capo_inspector2.types.get_configuration_request.GetConfigurationRequest]",
    ) -> OperationResponse[
        "capo_inspector2.types.get_configuration_response.GetConfigurationResponse"
    ]:
        import capo_inspector2._operations.inspector2.get_configuration

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetConfiguration")
    )
    input_: capo_inspector2.types.get_configuration_request.GetConfigurationRequest = {}
    if account_id is not None:
        input_["account_id"] = account_id

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