batch_get_account_status ¶

batch_get_account_status(
    *,
    config_overrides: Optional[Inspector2ClientConfig] = None,
    account_ids: Optional[AccountIdSet] = None,
) -> BatchGetAccountStatusResponse

Retrieves the Amazon Inspector status of multiple Amazon Web Services accounts within your environment.

Parameters:

account_ids (Optional[AccountIdSet], default: None ) –

The 12-digit Amazon Web Services account IDs of the accounts to retrieve Amazon Inspector status for.

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 batch_get_account_status(
    self,
    *,
    config_overrides: Optional[Inspector2ClientConfig] = None,
    account_ids: Optional[
        "capo_inspector2.types.account_id_set.AccountIdSet"
    ] = None,
) -> "capo_inspector2.types.batch_get_account_status_response.BatchGetAccountStatusResponse":
    """<p>Retrieves the Amazon Inspector status of multiple Amazon Web Services accounts within your environment.</p>

    Args:
        account_ids: <p>The 12-digit Amazon Web Services account IDs of the accounts to retrieve Amazon Inspector status for.</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.batch_get_account_status_request.BatchGetAccountStatusRequest]",
    ) -> OperationResponse[
        "capo_inspector2.types.batch_get_account_status_response.BatchGetAccountStatusResponse"
    ]:
        import capo_inspector2._operations.inspector2.batch_get_account_status

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("BatchGetAccountStatus")
    )
    input_: capo_inspector2.types.batch_get_account_status_request.BatchGetAccountStatusRequest = {}
    if account_ids is not None:
        input_["account_ids"] = account_ids

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