Skip to content

get_organization_statistics

Operation

get_organization_statistics

get_organization_statistics(request: GetOrganizationStatisticsInput | GetOrganizationStatisticsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetOrganizationStatisticsInputDict]) -> GetOrganizationStatisticsOutput

Retrieves how many active member accounts have each feature enabled within GuardDuty. Only a delegated GuardDuty administrator of an organization can run this API.

When you create a new organization, it might take up to 24 hours to generate the statistics for the entire organization.

Parameters:

Name Type Description Default
request GetOrganizationStatisticsInput | GetOrganizationStatisticsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetOrganizationStatisticsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetOrganizationStatisticsOutput

An instance of GetOrganizationStatisticsOutput.

get_organization_statistics async

get_organization_statistics(request: GetOrganizationStatisticsInput | GetOrganizationStatisticsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetOrganizationStatisticsInputDict]) -> GetOrganizationStatisticsOutput

Retrieves how many active member accounts have each feature enabled within GuardDuty. Only a delegated GuardDuty administrator of an organization can run this API.

When you create a new organization, it might take up to 24 hours to generate the statistics for the entire organization.

Parameters:

Name Type Description Default
request GetOrganizationStatisticsInput | GetOrganizationStatisticsInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[GetOrganizationStatisticsInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetOrganizationStatisticsOutput

An instance of GetOrganizationStatisticsOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

GetOrganizationStatisticsInputDict

Bases: TypedDict

Dictionary form of GetOrganizationStatisticsInput.

GetOrganizationStatisticsInput dataclass

Bases: _SerdeShape

Dataclass for GetOrganizationStatisticsInput structure.

Output

GetOrganizationStatisticsOutput dataclass

Bases: _SerdeShape

Dataclass for GetOrganizationStatisticsOutput structure.

Attributes

organization_details class-attribute instance-attribute
organization_details: OrganizationDetails | None = ...

Information about the statistics report for your organization.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.