get_admin_scope `async` ¶

get_admin_scope(
    admin_account: AWSAccountId,
    *,
    config_overrides: Optional[AsyncFMSClientConfig] = None,
) -> GetAdminScopeResponse

Returns information about the specified account's administrative scope. The administrative scope defines the resources that an Firewall Manager administrator can manage.

Parameters:

admin_account (AWSAccountId) –

The administrator account that you want to get the details for.

Raises:

InternalErrorException –

The operation failed because of a system problem, even though the request was valid. Retry your request.
InvalidInputException –

The parameters of the request were invalid.
InvalidOperationException –

The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an AssociateAdminAccount request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.
LimitExceededException –

The operation exceeds a resource limit, for example, the maximum number of policy objects that you can create for an Amazon Web Services account. For more information, see Firewall Manager Limits in the WAF Developer Guide.
ResourceNotFoundException –

The specified resource was not found.
UnknownServiceError –

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

Source code in docs_src/capo_fms/_services/async_fms.py

async def get_admin_scope(
    self,
    admin_account: "capo_fms.types.aws_account_id.AWSAccountId",
    *,
    config_overrides: Optional[AsyncFMSClientConfig] = None,
) -> "capo_fms.types.get_admin_scope_response.GetAdminScopeResponse":
    """<p>Returns information about the specified account's administrative scope. The administrative scope defines the resources that an Firewall Manager administrator can manage.</p>

    Args:
        admin_account: <p>The administrator account that you want to get the details for.</p>

    Raises:
        capo_fms.errors.internal_error_exception.InternalErrorException: <p>The operation failed because of a system problem, even though the request was valid. Retry your request.</p>
        capo_fms.errors.invalid_input_exception.InvalidInputException: <p>The parameters of the request were invalid.</p>
        capo_fms.errors.invalid_operation_exception.InvalidOperationException: <p>The operation failed because there was nothing to do or the operation wasn't possible. For example, you might have submitted an <code>AssociateAdminAccount</code> request for an account ID that was already set as the Firewall Manager administrator. Or you might have tried to access a Region that's disabled by default, and that you need to enable for the Firewall Manager administrator account and for Organizations before you can access it.</p>
        capo_fms.errors.limit_exceeded_exception.LimitExceededException: <p>The operation exceeds a resource limit, for example, the maximum number of <code>policy</code> objects that you can create for an Amazon Web Services account. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/fms-limits.html">Firewall Manager Limits</a> in the <i>WAF Developer Guide</i>.</p>
        capo_fms.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_fms.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_fms.types.get_admin_scope_request.GetAdminScopeRequest]",
    ) -> AsyncOperationResponse[
        "capo_fms.types.get_admin_scope_response.GetAdminScopeResponse"
    ]:
        import capo_fms._operations.awsfms_20180101.get_admin_scope

        (
            output,
            http_response,
        ) = await capo_fms._operations.awsfms_20180101.get_admin_scope.async_get_admin_scope(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetAdminScope")
    )
    input_: capo_fms.types.get_admin_scope_request.GetAdminScopeRequest = {
        "admin_account": admin_account
    }

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

get_admin_scope async ¶

get_admin_scope `async` ¶