GuardDuty / Client / get_member_detectors

get_member_detectors#

GuardDuty.Client.get_member_detectors(**kwargs)#

Describes which data sources are enabled for the member account’s detector.

There might be regional differences because some data sources might not be available in all the Amazon Web Services Regions where GuardDuty is presently supported. For more information, see Regions and endpoints.

See also: AWS API Documentation

Request Syntax

response = client.get_member_detectors(
    DetectorId='string',
    AccountIds=[
        'string',
    ]
)
Parameters:

  • DetectorId (string) –

    [REQUIRED]

    The detector ID for the administrator account.

    To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.

  • AccountIds (list) –

    [REQUIRED]

    A list of member account IDs.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'MemberDataSourceConfigurations': [
        {
            'AccountId': 'string',
            'DataSources': {
                'CloudTrail': {
                    'Status': 'ENABLED'|'DISABLED'
                },
                'DNSLogs': {
                    'Status': 'ENABLED'|'DISABLED'
                },
                'FlowLogs': {
                    'Status': 'ENABLED'|'DISABLED'
                },
                'S3Logs': {
                    'Status': 'ENABLED'|'DISABLED'
                },
                'Kubernetes': {
                    'AuditLogs': {
                        'Status': 'ENABLED'|'DISABLED'
                    }
                },
                'MalwareProtection': {
                    'ScanEc2InstanceWithFindings': {
                        'EbsVolumes': {
                            'Status': 'ENABLED'|'DISABLED',
                            'Reason': 'string'
                        }
                    },
                    'ServiceRole': 'string'
                }
            },
            'Features': [
                {
                    'Name': 'S3_DATA_EVENTS'|'EKS_AUDIT_LOGS'|'EBS_MALWARE_PROTECTION'|'RDS_LOGIN_EVENTS'|'EKS_RUNTIME_MONITORING'|'LAMBDA_NETWORK_LOGS'|'RUNTIME_MONITORING',
                    'Status': 'ENABLED'|'DISABLED',
                    'UpdatedAt': datetime(2015, 1, 1),
                    'AdditionalConfiguration': [
                        {
                            'Name': 'EKS_ADDON_MANAGEMENT'|'ECS_FARGATE_AGENT_MANAGEMENT'|'EC2_AGENT_MANAGEMENT',
                            'Status': 'ENABLED'|'DISABLED',
                            'UpdatedAt': datetime(2015, 1, 1)
                        },
                    ]
                },
            ]
        },
    ],
    'UnprocessedAccounts': [
        {
            'AccountId': 'string',
            'Result': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • MemberDataSourceConfigurations (list) –

      An object that describes which data sources are enabled for a member account.

      • (dict) –

        Contains information on which data sources are enabled for a member account.

        • AccountId (string) –

          The account ID for the member account.

        • DataSources (dict) –

          Contains information on the status of data sources for the account.

          • CloudTrail (dict) –

            An object that contains information on the status of CloudTrail as a data source.

            • Status (string) –

              Describes whether CloudTrail is enabled as a data source for the detector.

          • DNSLogs (dict) –

            An object that contains information on the status of DNS logs as a data source.

            • Status (string) –

              Denotes whether DNS logs is enabled as a data source.

          • FlowLogs (dict) –

            An object that contains information on the status of VPC flow logs as a data source.

            • Status (string) –

              Denotes whether VPC flow logs is enabled as a data source.

          • S3Logs (dict) –

            An object that contains information on the status of S3 Data event logs as a data source.

            • Status (string) –

              A value that describes whether S3 data event logs are automatically enabled for new members of the organization.

          • Kubernetes (dict) –

            An object that contains information on the status of all Kubernetes data sources.

            • AuditLogs (dict) –

              Describes whether Kubernetes audit logs are enabled as a data source.

              • Status (string) –

                A value that describes whether Kubernetes audit logs are enabled as a data source.

          • MalwareProtection (dict) –

            Describes the configuration of Malware Protection data sources.

            • ScanEc2InstanceWithFindings (dict) –

              Describes the configuration of Malware Protection for EC2 instances with findings.

              • EbsVolumes (dict) –

                Describes the configuration of scanning EBS volumes as a data source.

                • Status (string) –

                  Describes whether scanning EBS volumes is enabled as a data source.

                • Reason (string) –

                  Specifies the reason why scanning EBS volumes (Malware Protection) was not enabled as a data source.

            • ServiceRole (string) –

              The GuardDuty Malware Protection service role.

        • Features (list) –

          Contains information about the status of the features for the member account.

          • (dict) –

            Contains information about the features for the member account.

            • Name (string) –

              Indicates the name of the feature that is enabled for the detector.

            • Status (string) –

              Indicates the status of the feature that is enabled for the detector.

            • UpdatedAt (datetime) –

              The timestamp at which the feature object was updated.

            • AdditionalConfiguration (list) –

              Indicates the additional configuration of the feature that is configured for the member account.

              • (dict) –

                Information about the additional configuration for the member account.

                • Name (string) –

                  Indicates the name of the additional configuration that is set for the member account.

                • Status (string) –

                  Indicates the status of the additional configuration that is set for the member account.

                • UpdatedAt (datetime) –

                  The timestamp at which the additional configuration was set for the member account. This is in UTC format.

    • UnprocessedAccounts (list) –

      A list of member account IDs that were unable to be processed along with an explanation for why they were not processed.

      • (dict) –

        Contains information about the accounts that weren’t processed.

        • AccountId (string) –

          The Amazon Web Services account ID.

        • Result (string) –

          A reason why the account hasn’t been processed.

Exceptions