GuardDuty

Table of Contents

Client

class GuardDuty.Client

A low-level client representing Amazon GuardDuty:

import boto3

client = boto3.client('guardduty')

These are the available methods:

accept_invitation(**kwargs)

Accepts the invitation to be monitored by a master GuardDuty account.

See also: AWS API Documentation

Request Syntax

response = client.accept_invitation(
    DetectorId='string',
    MasterId='string',
    InvitationId='string'
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The unique ID of the detector of the GuardDuty member account.

  • MasterId (string) --

    [REQUIRED]

    The account ID of the master GuardDuty account whose invitation you're accepting.

  • InvitationId (string) --

    [REQUIRED]

    The value that is used to validate the master account to the member account.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

archive_findings(**kwargs)

Archives GuardDuty findings that are specified by the list of finding IDs.

Note

Only the master account can archive findings. Member accounts don't have permission to archive findings from their accounts.

See also: AWS API Documentation

Request Syntax

response = client.archive_findings(
    DetectorId='string',
    FindingIds=[
        'string',
    ]
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The ID of the detector that specifies the GuardDuty service whose findings you want to archive.

  • FindingIds (list) --

    [REQUIRED]

    The IDs of the findings that you want to archive.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
create_detector(**kwargs)

Creates a single Amazon GuardDuty detector. A detector is a resource that represents the GuardDuty service. To start using GuardDuty, you must create a detector in each Region where you enable the service. You can have only one detector per account per Region.

See also: AWS API Documentation

Request Syntax

response = client.create_detector(
    Enable=True|False,
    ClientToken='string',
    FindingPublishingFrequency='FIFTEEN_MINUTES'|'ONE_HOUR'|'SIX_HOURS',
    Tags={
        'string': 'string'
    }
)
Parameters
  • Enable (boolean) --

    [REQUIRED]

    A Boolean value that specifies whether the detector is to be enabled.

  • ClientToken (string) --

    The idempotency token for the create request.

    This field is autopopulated if not provided.

  • FindingPublishingFrequency (string) -- An enum value that specifies how frequently updated findings are exported.
  • Tags (dict) --

    The tags to be added to a new detector resource.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'DetectorId': 'string'
}

Response Structure

  • (dict) --

    • DetectorId (string) --

      The unique ID of the created detector.

create_filter(**kwargs)

Creates a filter using the specified finding criteria.

See also: AWS API Documentation

Request Syntax

response = client.create_filter(
    DetectorId='string',
    Name='string',
    Description='string',
    Action='NOOP'|'ARCHIVE',
    Rank=123,
    FindingCriteria={
        'Criterion': {
            'string': {
                'Eq': [
                    'string',
                ],
                'Neq': [
                    'string',
                ],
                'Gt': 123,
                'Gte': 123,
                'Lt': 123,
                'Lte': 123,
                'Equals': [
                    'string',
                ],
                'NotEquals': [
                    'string',
                ],
                'GreaterThan': 123,
                'GreaterThanOrEqual': 123,
                'LessThan': 123,
                'LessThanOrEqual': 123
            }
        }
    },
    ClientToken='string',
    Tags={
        'string': 'string'
    }
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The unique ID of the detector of the GuardDuty account that you want to create a filter for.

  • Name (string) --

    [REQUIRED]

    The name of the filter.

  • Description (string) -- The description of the filter.
  • Action (string) -- Specifies the action that is to be applied to the findings that match the filter.
  • Rank (integer) -- Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings.
  • FindingCriteria (dict) --

    [REQUIRED]

    Represents the criteria to be used in the filter for querying findings.

    You can only use the following attributes to query findings:

    • accountId
    • region
    • confidence
    • id
    • resource.accessKeyDetails.accessKeyId
    • resource.accessKeyDetails.principalId
    • resource.accessKeyDetails.userName
    • resource.accessKeyDetails.userType
    • resource.instanceDetails.iamInstanceProfile.id
    • resource.instanceDetails.imageId
    • resource.instanceDetails.instanceId
    • resource.instanceDetails.outpostArn
    • resource.instanceDetails.networkInterfaces.ipv6Addresses
    • resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress
    • resource.instanceDetails.networkInterfaces.publicDnsName
    • resource.instanceDetails.networkInterfaces.publicIp
    • resource.instanceDetails.networkInterfaces.securityGroups.groupId
    • resource.instanceDetails.networkInterfaces.securityGroups.groupName
    • resource.instanceDetails.networkInterfaces.subnetId
    • resource.instanceDetails.networkInterfaces.vpcId
    • resource.instanceDetails.tags.key
    • resource.instanceDetails.tags.value
    • resource.resourceType
    • service.action.actionType
    • service.action.awsApiCallAction.api
    • service.action.awsApiCallAction.callerType
    • service.action.awsApiCallAction.remoteIpDetails.city.cityName
    • service.action.awsApiCallAction.remoteIpDetails.country.countryName
    • service.action.awsApiCallAction.remoteIpDetails.ipAddressV4
    • service.action.awsApiCallAction.remoteIpDetails.organization.asn
    • service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg
    • service.action.awsApiCallAction.serviceName
    • service.action.dnsRequestAction.domain
    • service.action.networkConnectionAction.blocked
    • service.action.networkConnectionAction.connectionDirection
    • service.action.networkConnectionAction.localPortDetails.port
    • service.action.networkConnectionAction.protocol
    • service.action.networkConnectionAction.remoteIpDetails.city.cityName
    • service.action.networkConnectionAction.remoteIpDetails.country.countryName
    • service.action.networkConnectionAction.remoteIpDetails.ipAddressV4
    • service.action.networkConnectionAction.remoteIpDetails.organization.asn
    • service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg
    • service.action.networkConnectionAction.remotePortDetails.port
    • service.additionalInfo.threatListName
    • service.archived When this attribute is set to TRUE, only archived findings are listed. When it's set to FALSE, only unarchived findings are listed. When this attribute is not set, all existing findings are listed.
    • service.resourceRole
    • severity
    • type
    • updatedAt Type: ISO 8601 string format: YYYY-MM-DDTHH:MM:SS.SSSZ or YYYY-MM-DDTHH:MM:SSZ depending on whether the value contains milliseconds.
    • Criterion (dict) --

      Represents a map of finding properties that match specified conditions and values when querying findings.

      • (string) --
        • (dict) --

          Contains information about the condition.

          • Eq (list) --

            Represents the equal condition to be applied to a single field when querying for findings.

            • (string) --
          • Neq (list) --

            Represents the not equal condition to be applied to a single field when querying for findings.

            • (string) --
          • Gt (integer) --

            Represents a greater than condition to be applied to a single field when querying for findings.

          • Gte (integer) --

            Represents a greater than or equal condition to be applied to a single field when querying for findings.

          • Lt (integer) --

            Represents a less than condition to be applied to a single field when querying for findings.

          • Lte (integer) --

            Represents a less than or equal condition to be applied to a single field when querying for findings.

          • Equals (list) --

            Represents an equal condition to be applied to a single field when querying for findings.

            • (string) --
          • NotEquals (list) --

            Represents a not equal condition to be applied to a single field when querying for findings.

            • (string) --
          • GreaterThan (integer) --

            Represents a greater than condition to be applied to a single field when querying for findings.

          • GreaterThanOrEqual (integer) --

            Represents a greater than or equal condition to be applied to a single field when querying for findings.

          • LessThan (integer) --

            Represents a less than condition to be applied to a single field when querying for findings.

          • LessThanOrEqual (integer) --

            Represents a less than or equal condition to be applied to a single field when querying for findings.

  • ClientToken (string) --

    The idempotency token for the create request.

    This field is autopopulated if not provided.

  • Tags (dict) --

    The tags to be added to a new filter resource.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'Name': 'string'
}

Response Structure

  • (dict) --

    • Name (string) --

      The name of the successfully created filter.

create_ip_set(**kwargs)

Creates a new IPSet, which is called a trusted IP list in the console user interface. An IPSet is a list of IP addresses that are trusted for secure communication with AWS infrastructure and applications. GuardDuty doesn't generate findings for IP addresses that are included in IPSets. Only users from the master account can use this operation.

See also: AWS API Documentation

Request Syntax

response = client.create_ip_set(
    DetectorId='string',
    Name='string',
    Format='TXT'|'STIX'|'OTX_CSV'|'ALIEN_VAULT'|'PROOF_POINT'|'FIRE_EYE',
    Location='string',
    Activate=True|False,
    ClientToken='string',
    Tags={
        'string': 'string'
    }
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The unique ID of the detector of the GuardDuty account that you want to create an IPSet for.

  • Name (string) --

    [REQUIRED]

    The user-friendly name to identify the IPSet.

    Allowed characters are alphanumerics, spaces, hyphens (-), and underscores (_).

  • Format (string) --

    [REQUIRED]

    The format of the file that contains the IPSet.

  • Location (string) --

    [REQUIRED]

    The URI of the file that contains the IPSet. For example: https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.

  • Activate (boolean) --

    [REQUIRED]

    A Boolean value that indicates whether GuardDuty is to start using the uploaded IPSet.

  • ClientToken (string) --

    The idempotency token for the create request.

    This field is autopopulated if not provided.

  • Tags (dict) --

    The tags to be added to a new IP set resource.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'IpSetId': 'string'
}

Response Structure

  • (dict) --

    • IpSetId (string) --

      The ID of the IPSet resource.

create_members(**kwargs)

Creates member accounts of the current AWS account by specifying a list of AWS account IDs. The current AWS account can then invite these members to manage GuardDuty in their accounts.

See also: AWS API Documentation

Request Syntax

response = client.create_members(
    DetectorId='string',
    AccountDetails=[
        {
            'AccountId': 'string',
            'Email': 'string'
        },
    ]
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The unique ID of the detector of the GuardDuty account that you want to associate member accounts with.

  • AccountDetails (list) --

    [REQUIRED]

    A list of account ID and email address pairs of the accounts that you want to associate with the master GuardDuty account.

    • (dict) --

      Contains information about the account.

      • AccountId (string) -- [REQUIRED]

        The member account ID.

      • Email (string) -- [REQUIRED]

        The email address of the member account.

Return type

dict

Returns

Response Syntax

{
    'UnprocessedAccounts': [
        {
            'AccountId': 'string',
            'Result': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • UnprocessedAccounts (list) --

      A list of objects that include the accountIds of the unprocessed accounts and a result string that explains why each was unprocessed.

      • (dict) --

        Contains information about the accounts that weren't processed.

        • AccountId (string) --

          The AWS account ID.

        • Result (string) --

          A reason why the account hasn't been processed.

create_publishing_destination(**kwargs)

Creates a publishing destination to export findings to. The resource to export findings to must exist before you use this operation.

See also: AWS API Documentation

Request Syntax

response = client.create_publishing_destination(
    DetectorId='string',
    DestinationType='S3',
    DestinationProperties={
        'DestinationArn': 'string',
        'KmsKeyArn': 'string'
    },
    ClientToken='string'
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The ID of the GuardDuty detector associated with the publishing destination.

  • DestinationType (string) --

    [REQUIRED]

    The type of resource for the publishing destination. Currently only Amazon S3 buckets are supported.

  • DestinationProperties (dict) --

    [REQUIRED]

    The properties of the publishing destination, including the ARNs for the destination and the KMS key used for encryption.

    • DestinationArn (string) --

      The ARN of the resource to publish to.

    • KmsKeyArn (string) --

      The ARN of the KMS key to use for encryption.

  • ClientToken (string) --

    The idempotency token for the request.

    This field is autopopulated if not provided.

Return type

dict

Returns

Response Syntax

{
    'DestinationId': 'string'
}

Response Structure

  • (dict) --

    • DestinationId (string) --

      The ID of the publishing destination that is created.

create_sample_findings(**kwargs)

Generates example findings of types specified by the list of finding types. If 'NULL' is specified for findingTypes , the API generates example findings of all supported finding types.

See also: AWS API Documentation

Request Syntax

response = client.create_sample_findings(
    DetectorId='string',
    FindingTypes=[
        'string',
    ]
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The ID of the detector to create sample findings for.

  • FindingTypes (list) --

    The types of sample findings to generate.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

create_threat_intel_set(**kwargs)

Creates a new ThreatIntelSet. ThreatIntelSets consist of known malicious IP addresses. GuardDuty generates findings based on ThreatIntelSets. Only users of the master account can use this operation.

See also: AWS API Documentation

Request Syntax

response = client.create_threat_intel_set(
    DetectorId='string',
    Name='string',
    Format='TXT'|'STIX'|'OTX_CSV'|'ALIEN_VAULT'|'PROOF_POINT'|'FIRE_EYE',
    Location='string',
    Activate=True|False,
    ClientToken='string',
    Tags={
        'string': 'string'
    }
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The unique ID of the detector of the GuardDuty account that you want to create a threatIntelSet for.

  • Name (string) --

    [REQUIRED]

    A user-friendly ThreatIntelSet name displayed in all findings that are generated by activity that involves IP addresses included in this ThreatIntelSet.

  • Format (string) --

    [REQUIRED]

    The format of the file that contains the ThreatIntelSet.

  • Location (string) --

    [REQUIRED]

    The URI of the file that contains the ThreatIntelSet. For example: https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.

  • Activate (boolean) --

    [REQUIRED]

    A Boolean value that indicates whether GuardDuty is to start using the uploaded ThreatIntelSet.

  • ClientToken (string) --

    The idempotency token for the create request.

    This field is autopopulated if not provided.

  • Tags (dict) --

    The tags to be added to a new threat list resource.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{
    'ThreatIntelSetId': 'string'
}

Response Structure

  • (dict) --

    • ThreatIntelSetId (string) --

      The ID of the ThreatIntelSet resource.

decline_invitations(**kwargs)

Declines invitations sent to the current member account by AWS accounts specified by their account IDs.

See also: AWS API Documentation

Request Syntax

response = client.decline_invitations(
    AccountIds=[
        'string',
    ]
)
Parameters
AccountIds (list) --

[REQUIRED]

A list of account IDs of the AWS accounts that sent invitations to the current member account that you want to decline invitations from.

  • (string) --
Return type
dict
Returns
Response Syntax
{
    'UnprocessedAccounts': [
        {
            'AccountId': 'string',
            'Result': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • UnprocessedAccounts (list) --

      A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.

      • (dict) --

        Contains information about the accounts that weren't processed.

        • AccountId (string) --

          The AWS account ID.

        • Result (string) --

          A reason why the account hasn't been processed.

delete_detector(**kwargs)

Deletes an Amazon GuardDuty detector that is specified by the detector ID.

See also: AWS API Documentation

Request Syntax

response = client.delete_detector(
    DetectorId='string'
)
Parameters
DetectorId (string) --

[REQUIRED]

The unique ID of the detector that you want to delete.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
delete_filter(**kwargs)

Deletes the filter specified by the filter name.

See also: AWS API Documentation

Request Syntax

response = client.delete_filter(
    DetectorId='string',
    FilterName='string'
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The unique ID of the detector that the filter is associated with.

  • FilterName (string) --

    [REQUIRED]

    The name of the filter that you want to delete.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

delete_invitations(**kwargs)

Deletes invitations sent to the current member account by AWS accounts specified by their account IDs.

See also: AWS API Documentation

Request Syntax

response = client.delete_invitations(
    AccountIds=[
        'string',
    ]
)
Parameters
AccountIds (list) --

[REQUIRED]

A list of account IDs of the AWS accounts that sent invitations to the current member account that you want to delete invitations from.

  • (string) --
Return type
dict
Returns
Response Syntax
{
    'UnprocessedAccounts': [
        {
            'AccountId': 'string',
            'Result': 'string'
        },
    ]
}

Response Structure

  • (dict) --
    • UnprocessedAccounts (list) --

      A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.

      • (dict) --

        Contains information about the accounts that weren't processed.

        • AccountId (string) --

          The AWS account ID.

        • Result (string) --

          A reason why the account hasn't been processed.

delete_ip_set(**kwargs)

Deletes the IPSet specified by the ipSetId . IPSets are called trusted IP lists in the console user interface.

See also: AWS API Documentation

Request Syntax

response = client.delete_ip_set(
    DetectorId='string',
    IpSetId='string'
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The unique ID of the detector associated with the IPSet.

  • IpSetId (string) --

    [REQUIRED]

    The unique ID of the IPSet to delete.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

delete_members(**kwargs)

Deletes GuardDuty member accounts (to the current GuardDuty master account) specified by the account IDs.

See also: AWS API Documentation

Request Syntax

response = client.delete_members(
    DetectorId='string',
    AccountIds=[
        'string',
    ]
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The unique ID of the detector of the GuardDuty account whose members you want to delete.

  • AccountIds (list) --

    [REQUIRED]

    A list of account IDs of the GuardDuty member accounts that you want to delete.

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'UnprocessedAccounts': [
        {
            'AccountId': 'string',
            'Result': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • UnprocessedAccounts (list) --

      The accounts that could not be processed.

      • (dict) --

        Contains information about the accounts that weren't processed.

        • AccountId (string) --

          The AWS account ID.

        • Result (string) --

          A reason why the account hasn't been processed.

delete_publishing_destination(**kwargs)

Deletes the publishing definition with the specified destinationId .

See also: AWS API Documentation

Request Syntax

response = client.delete_publishing_destination(
    DetectorId='string',
    DestinationId='string'
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The unique ID of the detector associated with the publishing destination to delete.

  • DestinationId (string) --

    [REQUIRED]

    The ID of the publishing destination to delete.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

delete_threat_intel_set(**kwargs)

Deletes the ThreatIntelSet specified by the ThreatIntelSet ID.

See also: AWS API Documentation

Request Syntax

response = client.delete_threat_intel_set(
    DetectorId='string',
    ThreatIntelSetId='string'
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The unique ID of the detector that the threatIntelSet is associated with.

  • ThreatIntelSetId (string) --

    [REQUIRED]

    The unique ID of the threatIntelSet that you want to delete.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

describe_organization_configuration(**kwargs)

Returns information about the account selected as the delegated administrator for GuardDuty.

See also: AWS API Documentation

Request Syntax

response = client.describe_organization_configuration(
    DetectorId='string'
)
Parameters
DetectorId (string) --

[REQUIRED]

The ID of the detector to retrieve information about the delegated administrator from.

Return type
dict
Returns
Response Syntax
{
    'AutoEnable': True|False,
    'MemberAccountLimitReached': True|False
}

Response Structure

  • (dict) --
    • AutoEnable (boolean) --

      Indicates whether GuardDuty is automatically enabled for accounts added to the organization.

    • MemberAccountLimitReached (boolean) --

      Indicates whether the maximum number of allowed member accounts are already associated with the delegated administrator master account.

describe_publishing_destination(**kwargs)

Returns information about the publishing destination specified by the provided destinationId .

See also: AWS API Documentation

Request Syntax

response = client.describe_publishing_destination(
    DetectorId='string',
    DestinationId='string'
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The unique ID of the detector associated with the publishing destination to retrieve.

  • DestinationId (string) --

    [REQUIRED]

    The ID of the publishing destination to retrieve.

Return type

dict

Returns

Response Syntax

{
    'DestinationId': 'string',
    'DestinationType': 'S3',
    'Status': 'PENDING_VERIFICATION'|'PUBLISHING'|'UNABLE_TO_PUBLISH_FIX_DESTINATION_PROPERTY'|'STOPPED',
    'PublishingFailureStartTimestamp': 123,
    'DestinationProperties': {
        'DestinationArn': 'string',
        'KmsKeyArn': 'string'
    }
}

Response Structure

  • (dict) --

    • DestinationId (string) --

      The ID of the publishing destination.

    • DestinationType (string) --

      The type of publishing destination. Currently, only Amazon S3 buckets are supported.

    • Status (string) --

      The status of the publishing destination.

    • PublishingFailureStartTimestamp (integer) --

      The time, in epoch millisecond format, at which GuardDuty was first unable to publish findings to the destination.

    • DestinationProperties (dict) --

      A DestinationProperties object that includes the DestinationArn and KmsKeyArn of the publishing destination.

      • DestinationArn (string) --

        The ARN of the resource to publish to.

      • KmsKeyArn (string) --

        The ARN of the KMS key to use for encryption.

disable_organization_admin_account(**kwargs)

Disables GuardDuty administrator permissions for an AWS account within the Organization.

See also: AWS API Documentation

Request Syntax

response = client.disable_organization_admin_account(
    AdminAccountId='string'
)
Parameters
AdminAccountId (string) --

[REQUIRED]

The AWS Account ID for the Organizations account to be disabled as a GuardDuty delegated administrator.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
disassociate_from_master_account(**kwargs)

Disassociates the current GuardDuty member account from its master account.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_from_master_account(
    DetectorId='string'
)
Parameters
DetectorId (string) --

[REQUIRED]

The unique ID of the detector of the GuardDuty member account.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
disassociate_members(**kwargs)

Disassociates GuardDuty member accounts (to the current GuardDuty master account) specified by the account IDs.

See also: AWS API Documentation

Request Syntax

response = client.disassociate_members(
    DetectorId='string',
    AccountIds=[
        'string',
    ]
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The unique ID of the detector of the GuardDuty account whose members you want to disassociate from the master account.

  • AccountIds (list) --

    [REQUIRED]

    A list of account IDs of the GuardDuty member accounts that you want to disassociate from the master account.

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'UnprocessedAccounts': [
        {
            'AccountId': 'string',
            'Result': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • UnprocessedAccounts (list) --

      A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.

      • (dict) --

        Contains information about the accounts that weren't processed.

        • AccountId (string) --

          The AWS account ID.

        • Result (string) --

          A reason why the account hasn't been processed.

enable_organization_admin_account(**kwargs)

Enables GuardDuty administrator permissions for an AWS account within the organization.

See also: AWS API Documentation

Request Syntax

response = client.enable_organization_admin_account(
    AdminAccountId='string'
)
Parameters
AdminAccountId (string) --

[REQUIRED]

The AWS Account ID for the Organizations account to be enabled as a GuardDuty delegated administrator.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --
generate_presigned_url(ClientMethod, Params=None, ExpiresIn=3600, HttpMethod=None)

Generate a presigned url given a client, its method, and arguments

Parameters
  • ClientMethod (string) -- The client method to presign for
  • Params (dict) -- The parameters normally passed to ClientMethod.
  • ExpiresIn (int) -- The number of seconds the presigned url is valid for. By default it expires in an hour (3600 seconds)
  • HttpMethod (string) -- The http method to use on the generated url. By default, the http method is whatever is used in the method's model.
Returns

The presigned url

get_detector(**kwargs)

Retrieves an Amazon GuardDuty detector specified by the detectorId.

See also: AWS API Documentation

Request Syntax

response = client.get_detector(
    DetectorId='string'
)
Parameters
DetectorId (string) --

[REQUIRED]

The unique ID of the detector that you want to get.

Return type
dict
Returns
Response Syntax
{
    'CreatedAt': 'string',
    'FindingPublishingFrequency': 'FIFTEEN_MINUTES'|'ONE_HOUR'|'SIX_HOURS',
    'ServiceRole': 'string',
    'Status': 'ENABLED'|'DISABLED',
    'UpdatedAt': 'string',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • CreatedAt (string) --

      The timestamp of when the detector was created.

    • FindingPublishingFrequency (string) --

      The publishing frequency of the finding.

    • ServiceRole (string) --

      The GuardDuty service role.

    • Status (string) --

      The detector status.

    • UpdatedAt (string) --

      The last-updated timestamp for the detector.

    • Tags (dict) --

      The tags of the detector resource.

      • (string) --
        • (string) --
get_filter(**kwargs)

Returns the details of the filter specified by the filter name.

See also: AWS API Documentation

Request Syntax

response = client.get_filter(
    DetectorId='string',
    FilterName='string'
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The unique ID of the detector that the filter is associated with.

  • FilterName (string) --

    [REQUIRED]

    The name of the filter you want to get.

Return type

dict

Returns

Response Syntax

{
    'Name': 'string',
    'Description': 'string',
    'Action': 'NOOP'|'ARCHIVE',
    'Rank': 123,
    'FindingCriteria': {
        'Criterion': {
            'string': {
                'Eq': [
                    'string',
                ],
                'Neq': [
                    'string',
                ],
                'Gt': 123,
                'Gte': 123,
                'Lt': 123,
                'Lte': 123,
                'Equals': [
                    'string',
                ],
                'NotEquals': [
                    'string',
                ],
                'GreaterThan': 123,
                'GreaterThanOrEqual': 123,
                'LessThan': 123,
                'LessThanOrEqual': 123
            }
        }
    },
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • Name (string) --

      The name of the filter.

    • Description (string) --

      The description of the filter.

    • Action (string) --

      Specifies the action that is to be applied to the findings that match the filter.

    • Rank (integer) --

      Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings.

    • FindingCriteria (dict) --

      Represents the criteria to be used in the filter for querying findings.

      • Criterion (dict) --

        Represents a map of finding properties that match specified conditions and values when querying findings.

        • (string) --

          • (dict) --

            Contains information about the condition.

            • Eq (list) --

              Represents the equal condition to be applied to a single field when querying for findings.

              • (string) --
            • Neq (list) --

              Represents the not equal condition to be applied to a single field when querying for findings.

              • (string) --
            • Gt (integer) --

              Represents a greater than condition to be applied to a single field when querying for findings.

            • Gte (integer) --

              Represents a greater than or equal condition to be applied to a single field when querying for findings.

            • Lt (integer) --

              Represents a less than condition to be applied to a single field when querying for findings.

            • Lte (integer) --

              Represents a less than or equal condition to be applied to a single field when querying for findings.

            • Equals (list) --

              Represents an equal condition to be applied to a single field when querying for findings.

              • (string) --
            • NotEquals (list) --

              Represents a not equal condition to be applied to a single field when querying for findings.

              • (string) --
            • GreaterThan (integer) --

              Represents a greater than condition to be applied to a single field when querying for findings.

            • GreaterThanOrEqual (integer) --

              Represents a greater than or equal condition to be applied to a single field when querying for findings.

            • LessThan (integer) --

              Represents a less than condition to be applied to a single field when querying for findings.

            • LessThanOrEqual (integer) --

              Represents a less than or equal condition to be applied to a single field when querying for findings.

    • Tags (dict) --

      The tags of the filter resource.

      • (string) --
        • (string) --

get_findings(**kwargs)

Describes Amazon GuardDuty findings specified by finding IDs.

See also: AWS API Documentation

Request Syntax

response = client.get_findings(
    DetectorId='string',
    FindingIds=[
        'string',
    ],
    SortCriteria={
        'AttributeName': 'string',
        'OrderBy': 'ASC'|'DESC'
    }
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The ID of the detector that specifies the GuardDuty service whose findings you want to retrieve.

  • FindingIds (list) --

    [REQUIRED]

    The IDs of the findings that you want to retrieve.

    • (string) --
  • SortCriteria (dict) --

    Represents the criteria used for sorting findings.

    • AttributeName (string) --

      Represents the finding attribute (for example, accountId) to sort findings by.

    • OrderBy (string) --

      The order by which the sorted findings are to be displayed.

Return type

dict

Returns

Response Syntax

{
    'Findings': [
        {
            'AccountId': 'string',
            'Arn': 'string',
            'Confidence': 123.0,
            'CreatedAt': 'string',
            'Description': 'string',
            'Id': 'string',
            'Partition': 'string',
            'Region': 'string',
            'Resource': {
                'AccessKeyDetails': {
                    'AccessKeyId': 'string',
                    'PrincipalId': 'string',
                    'UserName': 'string',
                    'UserType': 'string'
                },
                'InstanceDetails': {
                    'AvailabilityZone': 'string',
                    'IamInstanceProfile': {
                        'Arn': 'string',
                        'Id': 'string'
                    },
                    'ImageDescription': 'string',
                    'ImageId': 'string',
                    'InstanceId': 'string',
                    'InstanceState': 'string',
                    'InstanceType': 'string',
                    'OutpostArn': 'string',
                    'LaunchTime': 'string',
                    'NetworkInterfaces': [
                        {
                            'Ipv6Addresses': [
                                'string',
                            ],
                            'NetworkInterfaceId': 'string',
                            'PrivateDnsName': 'string',
                            'PrivateIpAddress': 'string',
                            'PrivateIpAddresses': [
                                {
                                    'PrivateDnsName': 'string',
                                    'PrivateIpAddress': 'string'
                                },
                            ],
                            'PublicDnsName': 'string',
                            'PublicIp': 'string',
                            'SecurityGroups': [
                                {
                                    'GroupId': 'string',
                                    'GroupName': 'string'
                                },
                            ],
                            'SubnetId': 'string',
                            'VpcId': 'string'
                        },
                    ],
                    'Platform': 'string',
                    'ProductCodes': [
                        {
                            'Code': 'string',
                            'ProductType': 'string'
                        },
                    ],
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ]
                },
                'ResourceType': 'string'
            },
            'SchemaVersion': 'string',
            'Service': {
                'Action': {
                    'ActionType': 'string',
                    'AwsApiCallAction': {
                        'Api': 'string',
                        'CallerType': 'string',
                        'DomainDetails': {
                            'Domain': 'string'
                        },
                        'RemoteIpDetails': {
                            'City': {
                                'CityName': 'string'
                            },
                            'Country': {
                                'CountryCode': 'string',
                                'CountryName': 'string'
                            },
                            'GeoLocation': {
                                'Lat': 123.0,
                                'Lon': 123.0
                            },
                            'IpAddressV4': 'string',
                            'Organization': {
                                'Asn': 'string',
                                'AsnOrg': 'string',
                                'Isp': 'string',
                                'Org': 'string'
                            }
                        },
                        'ServiceName': 'string'
                    },
                    'DnsRequestAction': {
                        'Domain': 'string'
                    },
                    'NetworkConnectionAction': {
                        'Blocked': True|False,
                        'ConnectionDirection': 'string',
                        'LocalPortDetails': {
                            'Port': 123,
                            'PortName': 'string'
                        },
                        'Protocol': 'string',
                        'LocalIpDetails': {
                            'IpAddressV4': 'string'
                        },
                        'RemoteIpDetails': {
                            'City': {
                                'CityName': 'string'
                            },
                            'Country': {
                                'CountryCode': 'string',
                                'CountryName': 'string'
                            },
                            'GeoLocation': {
                                'Lat': 123.0,
                                'Lon': 123.0
                            },
                            'IpAddressV4': 'string',
                            'Organization': {
                                'Asn': 'string',
                                'AsnOrg': 'string',
                                'Isp': 'string',
                                'Org': 'string'
                            }
                        },
                        'RemotePortDetails': {
                            'Port': 123,
                            'PortName': 'string'
                        }
                    },
                    'PortProbeAction': {
                        'Blocked': True|False,
                        'PortProbeDetails': [
                            {
                                'LocalPortDetails': {
                                    'Port': 123,
                                    'PortName': 'string'
                                },
                                'LocalIpDetails': {
                                    'IpAddressV4': 'string'
                                },
                                'RemoteIpDetails': {
                                    'City': {
                                        'CityName': 'string'
                                    },
                                    'Country': {
                                        'CountryCode': 'string',
                                        'CountryName': 'string'
                                    },
                                    'GeoLocation': {
                                        'Lat': 123.0,
                                        'Lon': 123.0
                                    },
                                    'IpAddressV4': 'string',
                                    'Organization': {
                                        'Asn': 'string',
                                        'AsnOrg': 'string',
                                        'Isp': 'string',
                                        'Org': 'string'
                                    }
                                }
                            },
                        ]
                    }
                },
                'Evidence': {
                    'ThreatIntelligenceDetails': [
                        {
                            'ThreatListName': 'string',
                            'ThreatNames': [
                                'string',
                            ]
                        },
                    ]
                },
                'Archived': True|False,
                'Count': 123,
                'DetectorId': 'string',
                'EventFirstSeen': 'string',
                'EventLastSeen': 'string',
                'ResourceRole': 'string',
                'ServiceName': 'string',
                'UserFeedback': 'string'
            },
            'Severity': 123.0,
            'Title': 'string',
            'Type': 'string',
            'UpdatedAt': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • Findings (list) --

      A list of findings.

      • (dict) --

        Contains information about the finding, which is generated when abnormal or suspicious activity is detected.

        • AccountId (string) --

          The ID of the account in which the finding was generated.

        • Arn (string) --

          The ARN of the finding.

        • Confidence (float) --

          The confidence score for the finding.

        • CreatedAt (string) --

          The time and date when the finding was created.

        • Description (string) --

          The description of the finding.

        • Id (string) --

          The ID of the finding.

        • Partition (string) --

          The partition associated with the finding.

        • Region (string) --

          The Region where the finding was generated.

        • Resource (dict) --

          Contains information about the AWS resource associated with the activity that prompted GuardDuty to generate a finding.

          • AccessKeyDetails (dict) --

            The IAM access key details (IAM user information) of a user that engaged in the activity that prompted GuardDuty to generate a finding.

            • AccessKeyId (string) --

              The access key ID of the user.

            • PrincipalId (string) --

              The principal ID of the user.

            • UserName (string) --

              The name of the user.

            • UserType (string) --

              The type of the user.

          • InstanceDetails (dict) --

            The information about the EC2 instance associated with the activity that prompted GuardDuty to generate a finding.

            • AvailabilityZone (string) --

              The Availability Zone of the EC2 instance.

            • IamInstanceProfile (dict) --

              The profile information of the EC2 instance.

              • Arn (string) --

                The profile ARN of the EC2 instance.

              • Id (string) --

                The profile ID of the EC2 instance.

            • ImageDescription (string) --

              The image description of the EC2 instance.

            • ImageId (string) --

              The image ID of the EC2 instance.

            • InstanceId (string) --

              The ID of the EC2 instance.

            • InstanceState (string) --

              The state of the EC2 instance.

            • InstanceType (string) --

              The type of the EC2 instance.

            • OutpostArn (string) --

              The Amazon Resource Name (ARN) of the AWS Outpost. Only applicable to AWS Outposts instances.

            • LaunchTime (string) --

              The launch time of the EC2 instance.

            • NetworkInterfaces (list) --

              The elastic network interface information of the EC2 instance.

              • (dict) --

                Contains information about the elastic network interface of the EC2 instance.

                • Ipv6Addresses (list) --

                  A list of IPv6 addresses for the EC2 instance.

                  • (string) --
                • NetworkInterfaceId (string) --

                  The ID of the network interface.

                • PrivateDnsName (string) --

                  The private DNS name of the EC2 instance.

                • PrivateIpAddress (string) --

                  The private IP address of the EC2 instance.

                • PrivateIpAddresses (list) --

                  Other private IP address information of the EC2 instance.

                  • (dict) --

                    Contains other private IP address information of the EC2 instance.

                    • PrivateDnsName (string) --

                      The private DNS name of the EC2 instance.

                    • PrivateIpAddress (string) --

                      The private IP address of the EC2 instance.

                • PublicDnsName (string) --

                  The public DNS name of the EC2 instance.

                • PublicIp (string) --

                  The public IP address of the EC2 instance.

                • SecurityGroups (list) --

                  The security groups associated with the EC2 instance.

                  • (dict) --

                    Contains information about the security groups associated with the EC2 instance.

                    • GroupId (string) --

                      The security group ID of the EC2 instance.

                    • GroupName (string) --

                      The security group name of the EC2 instance.

                • SubnetId (string) --

                  The subnet ID of the EC2 instance.

                • VpcId (string) --

                  The VPC ID of the EC2 instance.

            • Platform (string) --

              The platform of the EC2 instance.

            • ProductCodes (list) --

              The product code of the EC2 instance.

              • (dict) --

                Contains information about the product code for the EC2 instance.

                • Code (string) --

                  The product code information.

                • ProductType (string) --

                  The product code type.

            • Tags (list) --

              The tags of the EC2 instance.

              • (dict) --

                Contains information about a tag associated with the EC2 instance.

                • Key (string) --

                  The EC2 instance tag key.

                • Value (string) --

                  The EC2 instance tag value.

          • ResourceType (string) --

            The type of AWS resource.

        • SchemaVersion (string) --

          The version of the schema used for the finding.

        • Service (dict) --

          Contains additional information about the generated finding.

          • Action (dict) --

            Information about the activity that is described in a finding.

            • ActionType (string) --

              The GuardDuty finding activity type.

            • AwsApiCallAction (dict) --

              Information about the AWS_API_CALL action described in this finding.

              • Api (string) --

                The AWS API name.

              • CallerType (string) --

                The AWS API caller type.

              • DomainDetails (dict) --

                The domain information for the AWS API call.

                • Domain (string) --

                  The domain information for the AWS API call.

              • RemoteIpDetails (dict) --

                The remote IP information of the connection.

                • City (dict) --

                  The city information of the remote IP address.

                  • CityName (string) --

                    The city name of the remote IP address.

                • Country (dict) --

                  The country code of the remote IP address.

                  • CountryCode (string) --

                    The country code of the remote IP address.

                  • CountryName (string) --

                    The country name of the remote IP address.

                • GeoLocation (dict) --

                  The location information of the remote IP address.

                  • Lat (float) --

                    The latitude information of the remote IP address.

                  • Lon (float) --

                    The longitude information of the remote IP address.

                • IpAddressV4 (string) --

                  The IPv4 remote address of the connection.

                • Organization (dict) --

                  The ISP organization information of the remote IP address.

                  • Asn (string) --

                    The Autonomous System Number (ASN) of the internet provider of the remote IP address.

                  • AsnOrg (string) --

                    The organization that registered this ASN.

                  • Isp (string) --

                    The ISP information for the internet provider.

                  • Org (string) --

                    The name of the internet provider.

              • ServiceName (string) --

                The AWS service name whose API was invoked.

            • DnsRequestAction (dict) --

              Information about the DNS_REQUEST action described in this finding.

              • Domain (string) --

                The domain information for the API request.

            • NetworkConnectionAction (dict) --

              Information about the NETWORK_CONNECTION action described in this finding.

              • Blocked (boolean) --

                Indicates whether EC2 blocked the network connection to your instance.

              • ConnectionDirection (string) --

                The network connection direction.

              • LocalPortDetails (dict) --

                The local port information of the connection.

                • Port (integer) --

                  The port number of the local connection.

                • PortName (string) --

                  The port name of the local connection.

              • Protocol (string) --

                The network connection protocol.

              • LocalIpDetails (dict) --

                The local IP information of the connection.

                • IpAddressV4 (string) --

                  The IPv4 local address of the connection.

              • RemoteIpDetails (dict) --

                The remote IP information of the connection.

                • City (dict) --

                  The city information of the remote IP address.

                  • CityName (string) --

                    The city name of the remote IP address.

                • Country (dict) --

                  The country code of the remote IP address.

                  • CountryCode (string) --

                    The country code of the remote IP address.

                  • CountryName (string) --

                    The country name of the remote IP address.

                • GeoLocation (dict) --

                  The location information of the remote IP address.

                  • Lat (float) --

                    The latitude information of the remote IP address.

                  • Lon (float) --

                    The longitude information of the remote IP address.

                • IpAddressV4 (string) --

                  The IPv4 remote address of the connection.

                • Organization (dict) --

                  The ISP organization information of the remote IP address.

                  • Asn (string) --

                    The Autonomous System Number (ASN) of the internet provider of the remote IP address.

                  • AsnOrg (string) --

                    The organization that registered this ASN.

                  • Isp (string) --

                    The ISP information for the internet provider.

                  • Org (string) --

                    The name of the internet provider.

              • RemotePortDetails (dict) --

                The remote port information of the connection.

                • Port (integer) --

                  The port number of the remote connection.

                • PortName (string) --

                  The port name of the remote connection.

            • PortProbeAction (dict) --

              Information about the PORT_PROBE action described in this finding.

              • Blocked (boolean) --

                Indicates whether EC2 blocked the port probe to the instance, such as with an ACL.

              • PortProbeDetails (list) --

                A list of objects related to port probe details.

                • (dict) --

                  Contains information about the port probe details.

                  • LocalPortDetails (dict) --

                    The local port information of the connection.

                    • Port (integer) --

                      The port number of the local connection.

                    • PortName (string) --

                      The port name of the local connection.

                  • LocalIpDetails (dict) --

                    The local IP information of the connection.

                    • IpAddressV4 (string) --

                      The IPv4 local address of the connection.

                  • RemoteIpDetails (dict) --

                    The remote IP information of the connection.

                    • City (dict) --

                      The city information of the remote IP address.

                      • CityName (string) --

                        The city name of the remote IP address.

                    • Country (dict) --

                      The country code of the remote IP address.

                      • CountryCode (string) --

                        The country code of the remote IP address.

                      • CountryName (string) --

                        The country name of the remote IP address.

                    • GeoLocation (dict) --

                      The location information of the remote IP address.

                      • Lat (float) --

                        The latitude information of the remote IP address.

                      • Lon (float) --

                        The longitude information of the remote IP address.

                    • IpAddressV4 (string) --

                      The IPv4 remote address of the connection.

                    • Organization (dict) --

                      The ISP organization information of the remote IP address.

                      • Asn (string) --

                        The Autonomous System Number (ASN) of the internet provider of the remote IP address.

                      • AsnOrg (string) --

                        The organization that registered this ASN.

                      • Isp (string) --

                        The ISP information for the internet provider.

                      • Org (string) --

                        The name of the internet provider.

          • Evidence (dict) --

            An evidence object associated with the service.

            • ThreatIntelligenceDetails (list) --

              A list of threat intelligence details related to the evidence.

              • (dict) --

                An instance of a threat intelligence detail that constitutes evidence for the finding.

                • ThreatListName (string) --

                  The name of the threat intelligence list that triggered the finding.

                • ThreatNames (list) --

                  A list of names of the threats in the threat intelligence list that triggered the finding.

                  • (string) --
          • Archived (boolean) --

            Indicates whether this finding is archived.

          • Count (integer) --

            The total count of the occurrences of this finding type.

          • DetectorId (string) --

            The detector ID for the GuardDuty service.

          • EventFirstSeen (string) --

            The first-seen timestamp of the activity that prompted GuardDuty to generate this finding.

          • EventLastSeen (string) --

            The last-seen timestamp of the activity that prompted GuardDuty to generate this finding.

          • ResourceRole (string) --

            The resource role information for this finding.

          • ServiceName (string) --

            The name of the AWS service (GuardDuty) that generated a finding.

          • UserFeedback (string) --

            Feedback that was submitted about the finding.

        • Severity (float) --

          The severity of the finding.

        • Title (string) --

          The title of the finding.

        • Type (string) --

          The type of finding.

        • UpdatedAt (string) --

          The time and date when the finding was last updated.

get_findings_statistics(**kwargs)

Lists Amazon GuardDuty findings statistics for the specified detector ID.

See also: AWS API Documentation

Request Syntax

response = client.get_findings_statistics(
    DetectorId='string',
    FindingStatisticTypes=[
        'COUNT_BY_SEVERITY',
    ],
    FindingCriteria={
        'Criterion': {
            'string': {
                'Eq': [
                    'string',
                ],
                'Neq': [
                    'string',
                ],
                'Gt': 123,
                'Gte': 123,
                'Lt': 123,
                'Lte': 123,
                'Equals': [
                    'string',
                ],
                'NotEquals': [
                    'string',
                ],
                'GreaterThan': 123,
                'GreaterThanOrEqual': 123,
                'LessThan': 123,
                'LessThanOrEqual': 123
            }
        }
    }
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The ID of the detector that specifies the GuardDuty service whose findings' statistics you want to retrieve.

  • FindingStatisticTypes (list) --

    [REQUIRED]

    The types of finding statistics to retrieve.

    • (string) --
  • FindingCriteria (dict) --

    Represents the criteria that is used for querying findings.

    • Criterion (dict) --

      Represents a map of finding properties that match specified conditions and values when querying findings.

      • (string) --
        • (dict) --

          Contains information about the condition.

          • Eq (list) --

            Represents the equal condition to be applied to a single field when querying for findings.

            • (string) --
          • Neq (list) --

            Represents the not equal condition to be applied to a single field when querying for findings.

            • (string) --
          • Gt (integer) --

            Represents a greater than condition to be applied to a single field when querying for findings.

          • Gte (integer) --

            Represents a greater than or equal condition to be applied to a single field when querying for findings.

          • Lt (integer) --

            Represents a less than condition to be applied to a single field when querying for findings.

          • Lte (integer) --

            Represents a less than or equal condition to be applied to a single field when querying for findings.

          • Equals (list) --

            Represents an equal condition to be applied to a single field when querying for findings.

            • (string) --
          • NotEquals (list) --

            Represents a not equal condition to be applied to a single field when querying for findings.

            • (string) --
          • GreaterThan (integer) --

            Represents a greater than condition to be applied to a single field when querying for findings.

          • GreaterThanOrEqual (integer) --

            Represents a greater than or equal condition to be applied to a single field when querying for findings.

          • LessThan (integer) --

            Represents a less than condition to be applied to a single field when querying for findings.

          • LessThanOrEqual (integer) --

            Represents a less than or equal condition to be applied to a single field when querying for findings.

Return type

dict

Returns

Response Syntax

{
    'FindingStatistics': {
        'CountBySeverity': {
            'string': 123
        }
    }
}

Response Structure

  • (dict) --

    • FindingStatistics (dict) --

      The finding statistics object.

      • CountBySeverity (dict) --

        Represents a map of severity to count statistics for a set of findings.

        • (string) --
          • (integer) --

get_invitations_count()

Returns the count of all GuardDuty membership invitations that were sent to the current member account except the currently accepted invitation.

See also: AWS API Documentation

Request Syntax

response = client.get_invitations_count()
Return type
dict
Returns
Response Syntax
{
    'InvitationsCount': 123
}

Response Structure

  • (dict) --
    • InvitationsCount (integer) --

      The number of received invitations.

get_ip_set(**kwargs)

Retrieves the IPSet specified by the ipSetId .

See also: AWS API Documentation

Request Syntax

response = client.get_ip_set(
    DetectorId='string',
    IpSetId='string'
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The unique ID of the detector that the IPSet is associated with.

  • IpSetId (string) --

    [REQUIRED]

    The unique ID of the IPSet to retrieve.

Return type

dict

Returns

Response Syntax

{
    'Name': 'string',
    'Format': 'TXT'|'STIX'|'OTX_CSV'|'ALIEN_VAULT'|'PROOF_POINT'|'FIRE_EYE',
    'Location': 'string',
    'Status': 'INACTIVE'|'ACTIVATING'|'ACTIVE'|'DEACTIVATING'|'ERROR'|'DELETE_PENDING'|'DELETED',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • Name (string) --

      The user-friendly name for the IPSet.

    • Format (string) --

      The format of the file that contains the IPSet.

    • Location (string) --

      The URI of the file that contains the IPSet. For example: https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.

    • Status (string) --

      The status of IPSet file that was uploaded.

    • Tags (dict) --

      The tags of the IPSet resource.

      • (string) --
        • (string) --

get_master_account(**kwargs)

Provides the details for the GuardDuty master account associated with the current GuardDuty member account.

See also: AWS API Documentation

Request Syntax

response = client.get_master_account(
    DetectorId='string'
)
Parameters
DetectorId (string) --

[REQUIRED]

The unique ID of the detector of the GuardDuty member account.

Return type
dict
Returns
Response Syntax
{
    'Master': {
        'AccountId': 'string',
        'InvitationId': 'string',
        'RelationshipStatus': 'string',
        'InvitedAt': 'string'
    }
}

Response Structure

  • (dict) --
    • Master (dict) --

      The master account details.

      • AccountId (string) --

        The ID of the account used as the master account.

      • InvitationId (string) --

        The value used to validate the master account to the member account.

      • RelationshipStatus (string) --

        The status of the relationship between the master and member accounts.

      • InvitedAt (string) --

        The timestamp when the invitation was sent.

get_members(**kwargs)

Retrieves GuardDuty member accounts (to the current GuardDuty master account) specified by the account IDs.

See also: AWS API Documentation

Request Syntax

response = client.get_members(
    DetectorId='string',
    AccountIds=[
        'string',
    ]
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The unique ID of the detector of the GuardDuty account whose members you want to retrieve.

  • AccountIds (list) --

    [REQUIRED]

    A list of account IDs of the GuardDuty member accounts that you want to describe.

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'Members': [
        {
            'AccountId': 'string',
            'DetectorId': 'string',
            'MasterId': 'string',
            'Email': 'string',
            'RelationshipStatus': 'string',
            'InvitedAt': 'string',
            'UpdatedAt': 'string'
        },
    ],
    'UnprocessedAccounts': [
        {
            'AccountId': 'string',
            'Result': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • Members (list) --

      A list of members.

      • (dict) --

        Contains information about the member account.

        • AccountId (string) --

          The ID of the member account.

        • DetectorId (string) --

          The detector ID of the member account.

        • MasterId (string) --

          The master account ID.

        • Email (string) --

          The email address of the member account.

        • RelationshipStatus (string) --

          The status of the relationship between the member and the master.

        • InvitedAt (string) --

          The timestamp when the invitation was sent.

        • UpdatedAt (string) --

          The last-updated timestamp of the member.

    • UnprocessedAccounts (list) --

      A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.

      • (dict) --

        Contains information about the accounts that weren't processed.

        • AccountId (string) --

          The AWS account ID.

        • Result (string) --

          A reason why the account hasn't been processed.

get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_threat_intel_set(**kwargs)

Retrieves the ThreatIntelSet that is specified by the ThreatIntelSet ID.

See also: AWS API Documentation

Request Syntax

response = client.get_threat_intel_set(
    DetectorId='string',
    ThreatIntelSetId='string'
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The unique ID of the detector that the threatIntelSet is associated with.

  • ThreatIntelSetId (string) --

    [REQUIRED]

    The unique ID of the threatIntelSet that you want to get.

Return type

dict

Returns

Response Syntax

{
    'Name': 'string',
    'Format': 'TXT'|'STIX'|'OTX_CSV'|'ALIEN_VAULT'|'PROOF_POINT'|'FIRE_EYE',
    'Location': 'string',
    'Status': 'INACTIVE'|'ACTIVATING'|'ACTIVE'|'DEACTIVATING'|'ERROR'|'DELETE_PENDING'|'DELETED',
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --

    • Name (string) --

      A user-friendly ThreatIntelSet name displayed in all findings that are generated by activity that involves IP addresses included in this ThreatIntelSet.

    • Format (string) --

      The format of the threatIntelSet.

    • Location (string) --

      The URI of the file that contains the ThreatIntelSet. For example: https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.

    • Status (string) --

      The status of threatIntelSet file uploaded.

    • Tags (dict) --

      The tags of the threat list resource.

      • (string) --
        • (string) --

get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
invite_members(**kwargs)

Invites other AWS accounts (created as members of the current AWS account by CreateMembers) to enable GuardDuty, and allow the current AWS account to view and manage these accounts' GuardDuty findings on their behalf as the master account.

See also: AWS API Documentation

Request Syntax

response = client.invite_members(
    DetectorId='string',
    AccountIds=[
        'string',
    ],
    DisableEmailNotification=True|False,
    Message='string'
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The unique ID of the detector of the GuardDuty account that you want to invite members with.

  • AccountIds (list) --

    [REQUIRED]

    A list of account IDs of the accounts that you want to invite to GuardDuty as members.

    • (string) --
  • DisableEmailNotification (boolean) -- A Boolean value that specifies whether you want to disable email notification to the accounts that you’re inviting to GuardDuty as members.
  • Message (string) -- The invitation message that you want to send to the accounts that you’re inviting to GuardDuty as members.
Return type

dict

Returns

Response Syntax

{
    'UnprocessedAccounts': [
        {
            'AccountId': 'string',
            'Result': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • UnprocessedAccounts (list) --

      A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.

      • (dict) --

        Contains information about the accounts that weren't processed.

        • AccountId (string) --

          The AWS account ID.

        • Result (string) --

          A reason why the account hasn't been processed.

list_detectors(**kwargs)

Lists detectorIds of all the existing Amazon GuardDuty detector resources.

See also: AWS API Documentation

Request Syntax

response = client.list_detectors(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) -- You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.
  • NextToken (string) -- You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
Return type

dict

Returns

Response Syntax

{
    'DetectorIds': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • DetectorIds (list) --

      A list of detector IDs.

      • (string) --
    • NextToken (string) --

      The pagination parameter to be used on the next list operation to retrieve more items.

list_filters(**kwargs)

Returns a paginated list of the current filters.

See also: AWS API Documentation

Request Syntax

response = client.list_filters(
    DetectorId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The unique ID of the detector that the filter is associated with.

  • MaxResults (integer) -- You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.
  • NextToken (string) -- You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
Return type

dict

Returns

Response Syntax

{
    'FilterNames': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • FilterNames (list) --

      A list of filter names.

      • (string) --
    • NextToken (string) --

      The pagination parameter to be used on the next list operation to retrieve more items.

list_findings(**kwargs)

Lists Amazon GuardDuty findings for the specified detector ID.

See also: AWS API Documentation

Request Syntax

response = client.list_findings(
    DetectorId='string',
    FindingCriteria={
        'Criterion': {
            'string': {
                'Eq': [
                    'string',
                ],
                'Neq': [
                    'string',
                ],
                'Gt': 123,
                'Gte': 123,
                'Lt': 123,
                'Lte': 123,
                'Equals': [
                    'string',
                ],
                'NotEquals': [
                    'string',
                ],
                'GreaterThan': 123,
                'GreaterThanOrEqual': 123,
                'LessThan': 123,
                'LessThanOrEqual': 123
            }
        }
    },
    SortCriteria={
        'AttributeName': 'string',
        'OrderBy': 'ASC'|'DESC'
    },
    MaxResults=123,
    NextToken='string'
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The ID of the detector that specifies the GuardDuty service whose findings you want to list.

  • FindingCriteria (dict) --

    Represents the criteria used for querying findings. Valid values include:

    • JSON field name
    • accountId
    • region
    • confidence
    • id
    • resource.accessKeyDetails.accessKeyId
    • resource.accessKeyDetails.principalId
    • resource.accessKeyDetails.userName
    • resource.accessKeyDetails.userType
    • resource.instanceDetails.iamInstanceProfile.id
    • resource.instanceDetails.imageId
    • resource.instanceDetails.instanceId
    • resource.instanceDetails.networkInterfaces.ipv6Addresses
    • resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress
    • resource.instanceDetails.networkInterfaces.publicDnsName
    • resource.instanceDetails.networkInterfaces.publicIp
    • resource.instanceDetails.networkInterfaces.securityGroups.groupId
    • resource.instanceDetails.networkInterfaces.securityGroups.groupName
    • resource.instanceDetails.networkInterfaces.subnetId
    • resource.instanceDetails.networkInterfaces.vpcId
    • resource.instanceDetails.tags.key
    • resource.instanceDetails.tags.value
    • resource.resourceType
    • service.action.actionType
    • service.action.awsApiCallAction.api
    • service.action.awsApiCallAction.callerType
    • service.action.awsApiCallAction.remoteIpDetails.city.cityName
    • service.action.awsApiCallAction.remoteIpDetails.country.countryName
    • service.action.awsApiCallAction.remoteIpDetails.ipAddressV4
    • service.action.awsApiCallAction.remoteIpDetails.organization.asn
    • service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg
    • service.action.awsApiCallAction.serviceName
    • service.action.dnsRequestAction.domain
    • service.action.networkConnectionAction.blocked
    • service.action.networkConnectionAction.connectionDirection
    • service.action.networkConnectionAction.localPortDetails.port
    • service.action.networkConnectionAction.protocol
    • service.action.networkConnectionAction.remoteIpDetails.city.cityName
    • service.action.networkConnectionAction.remoteIpDetails.country.countryName
    • service.action.networkConnectionAction.remoteIpDetails.ipAddressV4
    • service.action.networkConnectionAction.remoteIpDetails.organization.asn
    • service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg
    • service.action.networkConnectionAction.remotePortDetails.port
    • service.additionalInfo.threatListName
    • service.archived When this attribute is set to 'true', only archived findings are listed. When it's set to 'false', only unarchived findings are listed. When this attribute is not set, all existing findings are listed.
    • service.resourceRole
    • severity
    • type
    • updatedAt Type: Timestamp in Unix Epoch millisecond format: 1486685375000
    • Criterion (dict) --

      Represents a map of finding properties that match specified conditions and values when querying findings.

      • (string) --
        • (dict) --

          Contains information about the condition.

          • Eq (list) --

            Represents the equal condition to be applied to a single field when querying for findings.

            • (string) --
          • Neq (list) --

            Represents the not equal condition to be applied to a single field when querying for findings.

            • (string) --
          • Gt (integer) --

            Represents a greater than condition to be applied to a single field when querying for findings.

          • Gte (integer) --

            Represents a greater than or equal condition to be applied to a single field when querying for findings.

          • Lt (integer) --

            Represents a less than condition to be applied to a single field when querying for findings.

          • Lte (integer) --

            Represents a less than or equal condition to be applied to a single field when querying for findings.

          • Equals (list) --

            Represents an equal condition to be applied to a single field when querying for findings.

            • (string) --
          • NotEquals (list) --

            Represents a not equal condition to be applied to a single field when querying for findings.

            • (string) --
          • GreaterThan (integer) --

            Represents a greater than condition to be applied to a single field when querying for findings.

          • GreaterThanOrEqual (integer) --

            Represents a greater than or equal condition to be applied to a single field when querying for findings.

          • LessThan (integer) --

            Represents a less than condition to be applied to a single field when querying for findings.

          • LessThanOrEqual (integer) --

            Represents a less than or equal condition to be applied to a single field when querying for findings.

  • SortCriteria (dict) --

    Represents the criteria used for sorting findings.

    • AttributeName (string) --

      Represents the finding attribute (for example, accountId) to sort findings by.

    • OrderBy (string) --

      The order by which the sorted findings are to be displayed.

  • MaxResults (integer) -- You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.
  • NextToken (string) -- You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
Return type

dict

Returns

Response Syntax

{
    'FindingIds': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • FindingIds (list) --

      The IDs of the findings that you're listing.

      • (string) --
    • NextToken (string) --

      The pagination parameter to be used on the next list operation to retrieve more items.

list_invitations(**kwargs)

Lists all GuardDuty membership invitations that were sent to the current AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_invitations(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) -- You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.
  • NextToken (string) -- You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
Return type

dict

Returns

Response Syntax

{
    'Invitations': [
        {
            'AccountId': 'string',
            'InvitationId': 'string',
            'RelationshipStatus': 'string',
            'InvitedAt': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Invitations (list) --

      A list of invitation descriptions.

      • (dict) --

        Contains information about the invitation to become a member account.

        • AccountId (string) --

          The ID of the account that the invitation was sent from.

        • InvitationId (string) --

          The ID of the invitation. This value is used to validate the inviter account to the member account.

        • RelationshipStatus (string) --

          The status of the relationship between the inviter and invitee accounts.

        • InvitedAt (string) --

          The timestamp when the invitation was sent.

    • NextToken (string) --

      The pagination parameter to be used on the next list operation to retrieve more items.

list_ip_sets(**kwargs)

Lists the IPSets of the GuardDuty service specified by the detector ID. If you use this operation from a member account, the IPSets returned are the IPSets from the associated master account.

See also: AWS API Documentation

Request Syntax

response = client.list_ip_sets(
    DetectorId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The unique ID of the detector that the IPSet is associated with.

  • MaxResults (integer) -- You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.
  • NextToken (string) -- You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
Return type

dict

Returns

Response Syntax

{
    'IpSetIds': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • IpSetIds (list) --

      The IDs of the IPSet resources.

      • (string) --
    • NextToken (string) --

      The pagination parameter to be used on the next list operation to retrieve more items.

list_members(**kwargs)

Lists details about associated member accounts for the current GuardDuty master account.

See also: AWS API Documentation

Request Syntax

response = client.list_members(
    DetectorId='string',
    MaxResults=123,
    NextToken='string',
    OnlyAssociated='string'
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The unique ID of the detector the member is associated with.

  • MaxResults (integer) -- You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.
  • NextToken (string) -- You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
  • OnlyAssociated (string) -- Specifies what member accounts the response includes based on their relationship status with the master account. The default value is "true". If set to "false" the response includes all existing member accounts (including members who haven't been invited yet or have been disassociated).
Return type

dict

Returns

Response Syntax

{
    'Members': [
        {
            'AccountId': 'string',
            'DetectorId': 'string',
            'MasterId': 'string',
            'Email': 'string',
            'RelationshipStatus': 'string',
            'InvitedAt': 'string',
            'UpdatedAt': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Members (list) --

      A list of members.

      • (dict) --

        Contains information about the member account.

        • AccountId (string) --

          The ID of the member account.

        • DetectorId (string) --

          The detector ID of the member account.

        • MasterId (string) --

          The master account ID.

        • Email (string) --

          The email address of the member account.

        • RelationshipStatus (string) --

          The status of the relationship between the member and the master.

        • InvitedAt (string) --

          The timestamp when the invitation was sent.

        • UpdatedAt (string) --

          The last-updated timestamp of the member.

    • NextToken (string) --

      The pagination parameter to be used on the next list operation to retrieve more items.

list_organization_admin_accounts(**kwargs)

Lists the accounts configured as AWS Organization delegated administrators.

See also: AWS API Documentation

Request Syntax

response = client.list_organization_admin_accounts(
    MaxResults=123,
    NextToken='string'
)
Parameters
  • MaxResults (integer) -- The maximum number of results to return in the response.
  • NextToken (string) -- A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.
Return type

dict

Returns

Response Syntax

{
    'AdminAccounts': [
        {
            'AdminAccountId': 'string',
            'AdminStatus': 'ENABLED'|'DISABLE_IN_PROGRESS'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • AdminAccounts (list) --

      An AdminAccounts object that includes a list of accounts configured as GuardDuty delegated administrators.

      • (dict) --

        The account within the organization specified as the GuardDuty delegated administrator.

        • AdminAccountId (string) --

          The AWS account ID for the account.

        • AdminStatus (string) --

          Indicates whether the account is enabled as the delegated administrator.

    • NextToken (string) --

      The pagination parameter to be used on the next list operation to retrieve more items.

list_publishing_destinations(**kwargs)

Returns a list of publishing destinations associated with the specified dectectorId .

See also: AWS API Documentation

Request Syntax

response = client.list_publishing_destinations(
    DetectorId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The ID of the detector to retrieve publishing destinations for.

  • MaxResults (integer) -- The maximum number of results to return in the response.
  • NextToken (string) -- A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.
Return type

dict

Returns

Response Syntax

{
    'Destinations': [
        {
            'DestinationId': 'string',
            'DestinationType': 'S3',
            'Status': 'PENDING_VERIFICATION'|'PUBLISHING'|'UNABLE_TO_PUBLISH_FIX_DESTINATION_PROPERTY'|'STOPPED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • Destinations (list) --

      A Destinations object that includes information about each publishing destination returned.

      • (dict) --

        Contains information about the publishing destination, including the ID, type, and status.

        • DestinationId (string) --

          The unique ID of the publishing destination.

        • DestinationType (string) --

          The type of resource used for the publishing destination. Currently, only Amazon S3 buckets are supported.

        • Status (string) --

          The status of the publishing destination.

    • NextToken (string) --

      A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

list_tags_for_resource(**kwargs)

Lists tags for a resource. Tagging is currently supported for detectors, finding filters, IP sets, and threat intel sets, with a limit of 50 tags per resource. When invoked, this operation returns all assigned tags for a given resource.

See also: AWS API Documentation

Request Syntax

response = client.list_tags_for_resource(
    ResourceArn='string'
)
Parameters
ResourceArn (string) --

[REQUIRED]

The Amazon Resource Name (ARN) for the given GuardDuty resource.

Return type
dict
Returns
Response Syntax
{
    'Tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • Tags (dict) --

      The tags associated with the resource.

      • (string) --
        • (string) --
list_threat_intel_sets(**kwargs)

Lists the ThreatIntelSets of the GuardDuty service specified by the detector ID. If you use this operation from a member account, the ThreatIntelSets associated with the master account are returned.

See also: AWS API Documentation

Request Syntax

response = client.list_threat_intel_sets(
    DetectorId='string',
    MaxResults=123,
    NextToken='string'
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The unique ID of the detector that the threatIntelSet is associated with.

  • MaxResults (integer) -- You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.
  • NextToken (string) -- You can use this parameter to paginate results in the response. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
Return type

dict

Returns

Response Syntax

{
    'ThreatIntelSetIds': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • ThreatIntelSetIds (list) --

      The IDs of the ThreatIntelSet resources.

      • (string) --
    • NextToken (string) --

      The pagination parameter to be used on the next list operation to retrieve more items.

start_monitoring_members(**kwargs)

Turns on GuardDuty monitoring of the specified member accounts. Use this operation to restart monitoring of accounts that you stopped monitoring with the StopMonitoringMembers operation.

See also: AWS API Documentation

Request Syntax

response = client.start_monitoring_members(
    DetectorId='string',
    AccountIds=[
        'string',
    ]
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The unique ID of the detector of the GuardDuty master account associated with the member accounts to monitor.

  • AccountIds (list) --

    [REQUIRED]

    A list of account IDs of the GuardDuty member accounts to start monitoring.

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'UnprocessedAccounts': [
        {
            'AccountId': 'string',
            'Result': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • UnprocessedAccounts (list) --

      A list of objects that contain the unprocessed account and a result string that explains why it was unprocessed.

      • (dict) --

        Contains information about the accounts that weren't processed.

        • AccountId (string) --

          The AWS account ID.

        • Result (string) --

          A reason why the account hasn't been processed.

stop_monitoring_members(**kwargs)

Stops GuardDuty monitoring for the specified member accounts. Use the StartMonitoringMembers operation to restart monitoring for those accounts.

See also: AWS API Documentation

Request Syntax

response = client.stop_monitoring_members(
    DetectorId='string',
    AccountIds=[
        'string',
    ]
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The unique ID of the detector associated with the GuardDuty master account that is monitoring member accounts.

  • AccountIds (list) --

    [REQUIRED]

    A list of account IDs for the member accounts to stop monitoring.

    • (string) --
Return type

dict

Returns

Response Syntax

{
    'UnprocessedAccounts': [
        {
            'AccountId': 'string',
            'Result': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • UnprocessedAccounts (list) --

      A list of objects that contain an accountId for each account that could not be processed, and a result string that indicates why the account was not processed.

      • (dict) --

        Contains information about the accounts that weren't processed.

        • AccountId (string) --

          The AWS account ID.

        • Result (string) --

          A reason why the account hasn't been processed.

tag_resource(**kwargs)

Adds tags to a resource.

See also: AWS API Documentation

Request Syntax

response = client.tag_resource(
    ResourceArn='string',
    Tags={
        'string': 'string'
    }
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) for the GuardDuty resource to apply a tag to.

  • Tags (dict) --

    [REQUIRED]

    The tags to be added to a resource.

    • (string) --
      • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

unarchive_findings(**kwargs)

Unarchives GuardDuty findings specified by the findingIds .

See also: AWS API Documentation

Request Syntax

response = client.unarchive_findings(
    DetectorId='string',
    FindingIds=[
        'string',
    ]
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The ID of the detector associated with the findings to unarchive.

  • FindingIds (list) --

    [REQUIRED]

    The IDs of the findings to unarchive.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

untag_resource(**kwargs)

Removes tags from a resource.

See also: AWS API Documentation

Request Syntax

response = client.untag_resource(
    ResourceArn='string',
    TagKeys=[
        'string',
    ]
)
Parameters
  • ResourceArn (string) --

    [REQUIRED]

    The Amazon Resource Name (ARN) for the resource to remove tags from.

  • TagKeys (list) --

    [REQUIRED]

    The tag keys to remove from the resource.

    • (string) --
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

update_detector(**kwargs)

Updates the Amazon GuardDuty detector specified by the detectorId.

See also: AWS API Documentation

Request Syntax

response = client.update_detector(
    DetectorId='string',
    Enable=True|False,
    FindingPublishingFrequency='FIFTEEN_MINUTES'|'ONE_HOUR'|'SIX_HOURS'
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The unique ID of the detector to update.

  • Enable (boolean) -- Specifies whether the detector is enabled or not enabled.
  • FindingPublishingFrequency (string) -- An enum value that specifies how frequently findings are exported, such as to CloudWatch Events.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

update_filter(**kwargs)

Updates the filter specified by the filter name.

See also: AWS API Documentation

Request Syntax

response = client.update_filter(
    DetectorId='string',
    FilterName='string',
    Description='string',
    Action='NOOP'|'ARCHIVE',
    Rank=123,
    FindingCriteria={
        'Criterion': {
            'string': {
                'Eq': [
                    'string',
                ],
                'Neq': [
                    'string',
                ],
                'Gt': 123,
                'Gte': 123,
                'Lt': 123,
                'Lte': 123,
                'Equals': [
                    'string',
                ],
                'NotEquals': [
                    'string',
                ],
                'GreaterThan': 123,
                'GreaterThanOrEqual': 123,
                'LessThan': 123,
                'LessThanOrEqual': 123
            }
        }
    }
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The unique ID of the detector that specifies the GuardDuty service where you want to update a filter.

  • FilterName (string) --

    [REQUIRED]

    The name of the filter.

  • Description (string) -- The description of the filter.
  • Action (string) -- Specifies the action that is to be applied to the findings that match the filter.
  • Rank (integer) -- Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings.
  • FindingCriteria (dict) --

    Represents the criteria to be used in the filter for querying findings.

    • Criterion (dict) --

      Represents a map of finding properties that match specified conditions and values when querying findings.

      • (string) --
        • (dict) --

          Contains information about the condition.

          • Eq (list) --

            Represents the equal condition to be applied to a single field when querying for findings.

            • (string) --
          • Neq (list) --

            Represents the not equal condition to be applied to a single field when querying for findings.

            • (string) --
          • Gt (integer) --

            Represents a greater than condition to be applied to a single field when querying for findings.

          • Gte (integer) --

            Represents a greater than or equal condition to be applied to a single field when querying for findings.

          • Lt (integer) --

            Represents a less than condition to be applied to a single field when querying for findings.

          • Lte (integer) --

            Represents a less than or equal condition to be applied to a single field when querying for findings.

          • Equals (list) --

            Represents an equal condition to be applied to a single field when querying for findings.

            • (string) --
          • NotEquals (list) --

            Represents a not equal condition to be applied to a single field when querying for findings.

            • (string) --
          • GreaterThan (integer) --

            Represents a greater than condition to be applied to a single field when querying for findings.

          • GreaterThanOrEqual (integer) --

            Represents a greater than or equal condition to be applied to a single field when querying for findings.

          • LessThan (integer) --

            Represents a less than condition to be applied to a single field when querying for findings.

          • LessThanOrEqual (integer) --

            Represents a less than or equal condition to be applied to a single field when querying for findings.

Return type

dict

Returns

Response Syntax

{
    'Name': 'string'
}

Response Structure

  • (dict) --

    • Name (string) --

      The name of the filter.

update_findings_feedback(**kwargs)

Marks the specified GuardDuty findings as useful or not useful.

See also: AWS API Documentation

Request Syntax

response = client.update_findings_feedback(
    DetectorId='string',
    FindingIds=[
        'string',
    ],
    Feedback='USEFUL'|'NOT_USEFUL',
    Comments='string'
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The ID of the detector associated with the findings to update feedback for.

  • FindingIds (list) --

    [REQUIRED]

    The IDs of the findings that you want to mark as useful or not useful.

    • (string) --
  • Feedback (string) --

    [REQUIRED]

    The feedback for the finding.

  • Comments (string) -- Additional feedback about the GuardDuty findings.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

update_ip_set(**kwargs)

Updates the IPSet specified by the IPSet ID.

See also: AWS API Documentation

Request Syntax

response = client.update_ip_set(
    DetectorId='string',
    IpSetId='string',
    Name='string',
    Location='string',
    Activate=True|False
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The detectorID that specifies the GuardDuty service whose IPSet you want to update.

  • IpSetId (string) --

    [REQUIRED]

    The unique ID that specifies the IPSet that you want to update.

  • Name (string) -- The unique ID that specifies the IPSet that you want to update.
  • Location (string) -- The updated URI of the file that contains the IPSet. For example: https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.
  • Activate (boolean) -- The updated Boolean value that specifies whether the IPSet is active or not.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

update_organization_configuration(**kwargs)

Updates the delegated administrator account with the values provided.

See also: AWS API Documentation

Request Syntax

response = client.update_organization_configuration(
    DetectorId='string',
    AutoEnable=True|False
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The ID of the detector to update the delegated administrator for.

  • AutoEnable (boolean) --

    [REQUIRED]

    Indicates whether to automatically enable member accounts in the organization.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

update_publishing_destination(**kwargs)

Updates information about the publishing destination specified by the destinationId .

See also: AWS API Documentation

Request Syntax

response = client.update_publishing_destination(
    DetectorId='string',
    DestinationId='string',
    DestinationProperties={
        'DestinationArn': 'string',
        'KmsKeyArn': 'string'
    }
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The ID of the detector associated with the publishing destinations to update.

  • DestinationId (string) --

    [REQUIRED]

    The ID of the publishing destination to update.

  • DestinationProperties (dict) --

    A DestinationProperties object that includes the DestinationArn and KmsKeyArn of the publishing destination.

    • DestinationArn (string) --

      The ARN of the resource to publish to.

    • KmsKeyArn (string) --

      The ARN of the KMS key to use for encryption.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

update_threat_intel_set(**kwargs)

Updates the ThreatIntelSet specified by the ThreatIntelSet ID.

See also: AWS API Documentation

Request Syntax

response = client.update_threat_intel_set(
    DetectorId='string',
    ThreatIntelSetId='string',
    Name='string',
    Location='string',
    Activate=True|False
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The detectorID that specifies the GuardDuty service whose ThreatIntelSet you want to update.

  • ThreatIntelSetId (string) --

    [REQUIRED]

    The unique ID that specifies the ThreatIntelSet that you want to update.

  • Name (string) -- The unique ID that specifies the ThreatIntelSet that you want to update.
  • Location (string) -- The updated URI of the file that contains the ThreateIntelSet. For example: https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key.
  • Activate (boolean) -- The updated Boolean value that specifies whether the ThreateIntelSet is active or not.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Paginators

The available paginators are:

class GuardDuty.Paginator.ListDetectors
paginator = client.get_paginator('list_detectors')
paginate(**kwargs)

Creates an iterator that will paginate through responses from GuardDuty.Client.list_detectors().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'DetectorIds': [
        'string',
    ],

}

Response Structure

  • (dict) --
    • DetectorIds (list) --

      A list of detector IDs.

      • (string) --
class GuardDuty.Paginator.ListFilters
paginator = client.get_paginator('list_filters')
paginate(**kwargs)

Creates an iterator that will paginate through responses from GuardDuty.Client.list_filters().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DetectorId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The unique ID of the detector that the filter is associated with.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'FilterNames': [
        'string',
    ],

}

Response Structure

  • (dict) --

    • FilterNames (list) --

      A list of filter names.

      • (string) --

class GuardDuty.Paginator.ListFindings
paginator = client.get_paginator('list_findings')
paginate(**kwargs)

Creates an iterator that will paginate through responses from GuardDuty.Client.list_findings().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DetectorId='string',
    FindingCriteria={
        'Criterion': {
            'string': {
                'Eq': [
                    'string',
                ],
                'Neq': [
                    'string',
                ],
                'Gt': 123,
                'Gte': 123,
                'Lt': 123,
                'Lte': 123,
                'Equals': [
                    'string',
                ],
                'NotEquals': [
                    'string',
                ],
                'GreaterThan': 123,
                'GreaterThanOrEqual': 123,
                'LessThan': 123,
                'LessThanOrEqual': 123
            }
        }
    },
    SortCriteria={
        'AttributeName': 'string',
        'OrderBy': 'ASC'|'DESC'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The ID of the detector that specifies the GuardDuty service whose findings you want to list.

  • FindingCriteria (dict) --

    Represents the criteria used for querying findings. Valid values include:

    • JSON field name
    • accountId
    • region
    • confidence
    • id
    • resource.accessKeyDetails.accessKeyId
    • resource.accessKeyDetails.principalId
    • resource.accessKeyDetails.userName
    • resource.accessKeyDetails.userType
    • resource.instanceDetails.iamInstanceProfile.id
    • resource.instanceDetails.imageId
    • resource.instanceDetails.instanceId
    • resource.instanceDetails.networkInterfaces.ipv6Addresses
    • resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress
    • resource.instanceDetails.networkInterfaces.publicDnsName
    • resource.instanceDetails.networkInterfaces.publicIp
    • resource.instanceDetails.networkInterfaces.securityGroups.groupId
    • resource.instanceDetails.networkInterfaces.securityGroups.groupName
    • resource.instanceDetails.networkInterfaces.subnetId
    • resource.instanceDetails.networkInterfaces.vpcId
    • resource.instanceDetails.tags.key
    • resource.instanceDetails.tags.value
    • resource.resourceType
    • service.action.actionType
    • service.action.awsApiCallAction.api
    • service.action.awsApiCallAction.callerType
    • service.action.awsApiCallAction.remoteIpDetails.city.cityName
    • service.action.awsApiCallAction.remoteIpDetails.country.countryName
    • service.action.awsApiCallAction.remoteIpDetails.ipAddressV4
    • service.action.awsApiCallAction.remoteIpDetails.organization.asn
    • service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg
    • service.action.awsApiCallAction.serviceName
    • service.action.dnsRequestAction.domain
    • service.action.networkConnectionAction.blocked
    • service.action.networkConnectionAction.connectionDirection
    • service.action.networkConnectionAction.localPortDetails.port
    • service.action.networkConnectionAction.protocol
    • service.action.networkConnectionAction.remoteIpDetails.city.cityName
    • service.action.networkConnectionAction.remoteIpDetails.country.countryName
    • service.action.networkConnectionAction.remoteIpDetails.ipAddressV4
    • service.action.networkConnectionAction.remoteIpDetails.organization.asn
    • service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg
    • service.action.networkConnectionAction.remotePortDetails.port
    • service.additionalInfo.threatListName
    • service.archived When this attribute is set to 'true', only archived findings are listed. When it's set to 'false', only unarchived findings are listed. When this attribute is not set, all existing findings are listed.
    • service.resourceRole
    • severity
    • type
    • updatedAt Type: Timestamp in Unix Epoch millisecond format: 1486685375000
    • Criterion (dict) --

      Represents a map of finding properties that match specified conditions and values when querying findings.

      • (string) --
        • (dict) --

          Contains information about the condition.

          • Eq (list) --

            Represents the equal condition to be applied to a single field when querying for findings.

            • (string) --
          • Neq (list) --

            Represents the not equal condition to be applied to a single field when querying for findings.

            • (string) --
          • Gt (integer) --

            Represents a greater than condition to be applied to a single field when querying for findings.

          • Gte (integer) --

            Represents a greater than or equal condition to be applied to a single field when querying for findings.

          • Lt (integer) --

            Represents a less than condition to be applied to a single field when querying for findings.

          • Lte (integer) --

            Represents a less than or equal condition to be applied to a single field when querying for findings.

          • Equals (list) --

            Represents an equal condition to be applied to a single field when querying for findings.

            • (string) --
          • NotEquals (list) --

            Represents a not equal condition to be applied to a single field when querying for findings.

            • (string) --
          • GreaterThan (integer) --

            Represents a greater than condition to be applied to a single field when querying for findings.

          • GreaterThanOrEqual (integer) --

            Represents a greater than or equal condition to be applied to a single field when querying for findings.

          • LessThan (integer) --

            Represents a less than condition to be applied to a single field when querying for findings.

          • LessThanOrEqual (integer) --

            Represents a less than or equal condition to be applied to a single field when querying for findings.

  • SortCriteria (dict) --

    Represents the criteria used for sorting findings.

    • AttributeName (string) --

      Represents the finding attribute (for example, accountId) to sort findings by.

    • OrderBy (string) --

      The order by which the sorted findings are to be displayed.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'FindingIds': [
        'string',
    ],

}

Response Structure

  • (dict) --

    • FindingIds (list) --

      The IDs of the findings that you're listing.

      • (string) --

class GuardDuty.Paginator.ListIPSets
paginator = client.get_paginator('list_ip_sets')
paginate(**kwargs)

Creates an iterator that will paginate through responses from GuardDuty.Client.list_ip_sets().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DetectorId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The unique ID of the detector that the IPSet is associated with.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'IpSetIds': [
        'string',
    ],

}

Response Structure

  • (dict) --

    • IpSetIds (list) --

      The IDs of the IPSet resources.

      • (string) --

class GuardDuty.Paginator.ListInvitations
paginator = client.get_paginator('list_invitations')
paginate(**kwargs)

Creates an iterator that will paginate through responses from GuardDuty.Client.list_invitations().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'Invitations': [
        {
            'AccountId': 'string',
            'InvitationId': 'string',
            'RelationshipStatus': 'string',
            'InvitedAt': 'string'
        },
    ],

}

Response Structure

  • (dict) --
    • Invitations (list) --

      A list of invitation descriptions.

      • (dict) --

        Contains information about the invitation to become a member account.

        • AccountId (string) --

          The ID of the account that the invitation was sent from.

        • InvitationId (string) --

          The ID of the invitation. This value is used to validate the inviter account to the member account.

        • RelationshipStatus (string) --

          The status of the relationship between the inviter and invitee accounts.

        • InvitedAt (string) --

          The timestamp when the invitation was sent.

class GuardDuty.Paginator.ListMembers
paginator = client.get_paginator('list_members')
paginate(**kwargs)

Creates an iterator that will paginate through responses from GuardDuty.Client.list_members().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DetectorId='string',
    OnlyAssociated='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The unique ID of the detector the member is associated with.

  • OnlyAssociated (string) -- Specifies what member accounts the response includes based on their relationship status with the master account. The default value is "true". If set to "false" the response includes all existing member accounts (including members who haven't been invited yet or have been disassociated).
  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'Members': [
        {
            'AccountId': 'string',
            'DetectorId': 'string',
            'MasterId': 'string',
            'Email': 'string',
            'RelationshipStatus': 'string',
            'InvitedAt': 'string',
            'UpdatedAt': 'string'
        },
    ],

}

Response Structure

  • (dict) --

    • Members (list) --

      A list of members.

      • (dict) --

        Contains information about the member account.

        • AccountId (string) --

          The ID of the member account.

        • DetectorId (string) --

          The detector ID of the member account.

        • MasterId (string) --

          The master account ID.

        • Email (string) --

          The email address of the member account.

        • RelationshipStatus (string) --

          The status of the relationship between the member and the master.

        • InvitedAt (string) --

          The timestamp when the invitation was sent.

        • UpdatedAt (string) --

          The last-updated timestamp of the member.

class GuardDuty.Paginator.ListOrganizationAdminAccounts
paginator = client.get_paginator('list_organization_admin_accounts')
paginate(**kwargs)

Creates an iterator that will paginate through responses from GuardDuty.Client.list_organization_admin_accounts().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
PaginationConfig (dict) --

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) --

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) --

    The size of each page.

  • StartingToken (string) --

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type
dict
Returns
Response Syntax
{
    'AdminAccounts': [
        {
            'AdminAccountId': 'string',
            'AdminStatus': 'ENABLED'|'DISABLE_IN_PROGRESS'
        },
    ],

}

Response Structure

  • (dict) --
    • AdminAccounts (list) --

      An AdminAccounts object that includes a list of accounts configured as GuardDuty delegated administrators.

      • (dict) --

        The account within the organization specified as the GuardDuty delegated administrator.

        • AdminAccountId (string) --

          The AWS account ID for the account.

        • AdminStatus (string) --

          Indicates whether the account is enabled as the delegated administrator.

class GuardDuty.Paginator.ListThreatIntelSets
paginator = client.get_paginator('list_threat_intel_sets')
paginate(**kwargs)

Creates an iterator that will paginate through responses from GuardDuty.Client.list_threat_intel_sets().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    DetectorId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • DetectorId (string) --

    [REQUIRED]

    The unique ID of the detector that the threatIntelSet is associated with.

  • PaginationConfig (dict) --

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) --

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) --

      The size of each page.

    • StartingToken (string) --

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type

dict

Returns

Response Syntax

{
    'ThreatIntelSetIds': [
        'string',
    ],

}

Response Structure

  • (dict) --

    • ThreatIntelSetIds (list) --

      The IDs of the ThreatIntelSet resources.

      • (string) --