Table of Contents
A low-level client representing Amazon GuardDuty:
import boto3
client = boto3.client('guardduty')
These are the available methods:
Accepts the invitation to be monitored by a master GuardDuty account.
See also: AWS API Documentation
Request Syntax
response = client.accept_invitation(
DetectorId='string',
InvitationId='string',
MasterId='string'
)
dict
Response Syntax
{}
Response Structure
Archives Amazon GuardDuty findings specified by the list of finding IDs.
See also: AWS API Documentation
Request Syntax
response = client.archive_findings(
DetectorId='string',
FindingIds=[
'string',
]
)
[REQUIRED] IDs of the findings that you want to archive.
dict
Response Syntax
{}
Response Structure
Check if an operation can be paginated.
Creates a single Amazon GuardDuty detector. A detector is an object that represents the GuardDuty service. A detector must be created in order for GuardDuty to become operational.
See also: AWS API Documentation
Request Syntax
response = client.create_detector(
ClientToken='string',
Enable=True|False,
FindingPublishingFrequency='FIFTEEN_MINUTES'|'ONE_HOUR'|'SIX_HOURS'
)
dict
Response Syntax
{
'DetectorId': 'string'
}
Response Structure
Creates a filter using the specified finding criteria.
See also: AWS API Documentation
Request Syntax
response = client.create_filter(
Action='NOOP'|'ARCHIVE',
ClientToken='string',
Description='string',
DetectorId='string',
FindingCriteria={
'Criterion': {
'string': {
'Eq': [
'string',
],
'Gt': 123,
'Gte': 123,
'Lt': 123,
'Lte': 123,
'Neq': [
'string',
]
}
}
},
Name='string',
Rank=123
)
[REQUIRED] Represents the criteria to be used in the filter for querying findings.
dict
Response Syntax
{
'Name': 'string'
}
Response Structure
Creates a new IPSet - a list of trusted IP addresses that have been whitelisted for secure communication with AWS infrastructure and applications.
See also: AWS API Documentation
Request Syntax
response = client.create_ip_set(
Activate=True|False,
ClientToken='string',
DetectorId='string',
Format='TXT'|'STIX'|'OTX_CSV'|'ALIEN_VAULT'|'PROOF_POINT'|'FIRE_EYE',
Location='string',
Name='string'
)
dict
Response Syntax
{
'IpSetId': 'string'
}
Response Structure
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(
AccountDetails=[
{
'AccountId': 'string',
'Email': 'string'
},
],
DetectorId='string'
)
[REQUIRED] A list of account ID and email address pairs of the accounts that you want to associate with the master GuardDuty account.
dict
Response Syntax
{
'UnprocessedAccounts': [
{
'AccountId': 'string',
'Result': 'string'
},
]
}
Response Structure
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',
]
)
Types of sample findings that you want to generate.
dict
Response Syntax
{}
Response Structure
Create a new ThreatIntelSet. ThreatIntelSets consist of known malicious IP addresses. GuardDuty generates findings based on ThreatIntelSets.
See also: AWS API Documentation
Request Syntax
response = client.create_threat_intel_set(
Activate=True|False,
ClientToken='string',
DetectorId='string',
Format='TXT'|'STIX'|'OTX_CSV'|'ALIEN_VAULT'|'PROOF_POINT'|'FIRE_EYE',
Location='string',
Name='string'
)
dict
Response Syntax
{
'ThreatIntelSetId': 'string'
}
Response Structure
Declines invitations sent to the current member account by AWS account specified by their account IDs.
See also: AWS API Documentation
Request Syntax
response = client.decline_invitations(
AccountIds=[
'string',
]
)
[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.
{
'UnprocessedAccounts': [
{
'AccountId': 'string',
'Result': 'string'
},
]
}
Response Structure
Deletes a Amazon GuardDuty detector specified by the detector ID.
See also: AWS API Documentation
Request Syntax
response = client.delete_detector(
DetectorId='string'
)
{}
Response Structure
Deletes the filter specified by the filter name.
See also: AWS API Documentation
Request Syntax
response = client.delete_filter(
DetectorId='string',
FilterName='string'
)
dict
Response Syntax
{}
Response Structure
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',
]
)
[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.
{
'UnprocessedAccounts': [
{
'AccountId': 'string',
'Result': 'string'
},
]
}
Response Structure
Deletes the IPSet specified by the IPSet ID.
See also: AWS API Documentation
Request Syntax
response = client.delete_ip_set(
DetectorId='string',
IpSetId='string'
)
dict
Response Syntax
{}
Response Structure
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(
AccountIds=[
'string',
],
DetectorId='string'
)
[REQUIRED] A list of account IDs of the GuardDuty member accounts that you want to delete.
dict
Response Syntax
{
'UnprocessedAccounts': [
{
'AccountId': 'string',
'Result': 'string'
},
]
}
Response Structure
Deletes ThreatIntelSet specified by the ThreatIntelSet ID.
See also: AWS API Documentation
Request Syntax
response = client.delete_threat_intel_set(
DetectorId='string',
ThreatIntelSetId='string'
)
dict
Response Syntax
{}
Response Structure
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'
)
{}
Response Structure
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(
AccountIds=[
'string',
],
DetectorId='string'
)
[REQUIRED] A list of account IDs of the GuardDuty member accounts that you want to disassociate from master.
dict
Response Syntax
{
'UnprocessedAccounts': [
{
'AccountId': 'string',
'Result': 'string'
},
]
}
Response Structure
Generate a presigned url given a client, its method, and arguments
The presigned url
Retrieves an Amazon GuardDuty detector specified by the detectorId.
See also: AWS API Documentation
Request Syntax
response = client.get_detector(
DetectorId='string'
)
{
'CreatedAt': 'string',
'FindingPublishingFrequency': 'FIFTEEN_MINUTES'|'ONE_HOUR'|'SIX_HOURS',
'ServiceRole': 'string',
'Status': 'ENABLED'|'DISABLED',
'UpdatedAt': 'string'
}
Response Structure
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'
)
dict
Response Syntax
{
'Action': 'NOOP'|'ARCHIVE',
'Description': 'string',
'FindingCriteria': {
'Criterion': {
'string': {
'Eq': [
'string',
],
'Gt': 123,
'Gte': 123,
'Lt': 123,
'Lte': 123,
'Neq': [
'string',
]
}
}
},
'Name': 'string',
'Rank': 123
}
Response Structure
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'
}
)
[REQUIRED] IDs of the findings that you want to retrieve.
Represents the criteria used for sorting findings.
dict
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',
'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': {},
'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',
'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'
},
'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'
}
}
},
]
}
},
'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
Lists Amazon GuardDuty findings' statistics for the specified detector ID.
See also: AWS API Documentation
Request Syntax
response = client.get_findings_statistics(
DetectorId='string',
FindingCriteria={
'Criterion': {
'string': {
'Eq': [
'string',
],
'Gt': 123,
'Gte': 123,
'Lt': 123,
'Lte': 123,
'Neq': [
'string',
]
}
}
},
FindingStatisticTypes=[
'COUNT_BY_SEVERITY',
]
)
Represents the criteria used for querying findings.
[REQUIRED] Types of finding statistics to retrieve.
dict
Response Syntax
{
'FindingStatistics': {
'CountBySeverity': {
'string': 123
}
}
}
Response Structure
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()
{
'InvitationsCount': 123
}
Response Structure
Retrieves the IPSet specified by the IPSet ID.
See also: AWS API Documentation
Request Syntax
response = client.get_ip_set(
DetectorId='string',
IpSetId='string'
)
dict
Response Syntax
{
'Format': 'TXT'|'STIX'|'OTX_CSV'|'ALIEN_VAULT'|'PROOF_POINT'|'FIRE_EYE',
'Location': 'string',
'Name': 'string',
'Status': 'INACTIVE'|'ACTIVATING'|'ACTIVE'|'DEACTIVATING'|'ERROR'|'DELETE_PENDING'|'DELETED'
}
Response Structure
Provides the details for the GuardDuty master account to the current GuardDuty member account.
See also: AWS API Documentation
Request Syntax
response = client.get_master_account(
DetectorId='string'
)
{
'Master': {
'AccountId': 'string',
'InvitationId': 'string',
'InvitedAt': 'string',
'RelationshipStatus': 'string'
}
}
Response Structure
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(
AccountIds=[
'string',
],
DetectorId='string'
)
[REQUIRED] A list of account IDs of the GuardDuty member accounts that you want to describe.
dict
Response Syntax
{
'Members': [
{
'AccountId': 'string',
'DetectorId': 'string',
'Email': 'string',
'InvitedAt': 'string',
'MasterId': 'string',
'RelationshipStatus': 'string',
'UpdatedAt': 'string'
},
],
'UnprocessedAccounts': [
{
'AccountId': 'string',
'Result': 'string'
},
]
}
Response Structure
Create a paginator for an operation.
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'
)
dict
Response Syntax
{
'Format': 'TXT'|'STIX'|'OTX_CSV'|'ALIEN_VAULT'|'PROOF_POINT'|'FIRE_EYE',
'Location': 'string',
'Name': 'string',
'Status': 'INACTIVE'|'ACTIVATING'|'ACTIVE'|'DEACTIVATING'|'ERROR'|'DELETE_PENDING'|'DELETED'
}
Response Structure
Returns an object that can wait for some condition.
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(
AccountIds=[
'string',
],
DetectorId='string',
DisableEmailNotification=True|False,
Message='string'
)
[REQUIRED] A list of account IDs of the accounts that you want to invite to GuardDuty as members.
dict
Response Syntax
{
'UnprocessedAccounts': [
{
'AccountId': 'string',
'Result': 'string'
},
]
}
Response Structure
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'
)
dict
Response Syntax
{
'DetectorIds': [
'string',
],
'NextToken': 'string'
}
Response Structure
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'
)
dict
Response Syntax
{
'FilterNames': [
'string',
],
'NextToken': 'string'
}
Response Structure
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',
],
'Gt': 123,
'Gte': 123,
'Lt': 123,
'Lte': 123,
'Neq': [
'string',
]
}
}
},
MaxResults=123,
NextToken='string',
SortCriteria={
'AttributeName': 'string',
'OrderBy': 'ASC'|'DESC'
}
)
Represents the criteria used for querying findings.
Represents the criteria used for sorting findings.
dict
Response Syntax
{
'FindingIds': [
'string',
],
'NextToken': 'string'
}
Response Structure
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'
)
dict
Response Syntax
{
'Invitations': [
{
'AccountId': 'string',
'InvitationId': 'string',
'InvitedAt': 'string',
'RelationshipStatus': 'string'
},
],
'NextToken': 'string'
}
Response Structure
Lists the IPSets of the GuardDuty service specified by the detector ID.
See also: AWS API Documentation
Request Syntax
response = client.list_ip_sets(
DetectorId='string',
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'IpSetIds': [
'string',
],
'NextToken': 'string'
}
Response Structure
Lists details about all 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'
)
dict
Response Syntax
{
'Members': [
{
'AccountId': 'string',
'DetectorId': 'string',
'Email': 'string',
'InvitedAt': 'string',
'MasterId': 'string',
'RelationshipStatus': 'string',
'UpdatedAt': 'string'
},
],
'NextToken': 'string'
}
Response Structure
Lists the ThreatIntelSets of the GuardDuty service specified by the detector ID.
See also: AWS API Documentation
Request Syntax
response = client.list_threat_intel_sets(
DetectorId='string',
MaxResults=123,
NextToken='string'
)
dict
Response Syntax
{
'NextToken': 'string',
'ThreatIntelSetIds': [
'string',
]
}
Response Structure
Re-enables GuardDuty to monitor findings of the member accounts specified by the account IDs. A master GuardDuty account can run this command after disabling GuardDuty from monitoring these members' findings by running StopMonitoringMembers.
See also: AWS API Documentation
Request Syntax
response = client.start_monitoring_members(
AccountIds=[
'string',
],
DetectorId='string'
)
[REQUIRED] A list of account IDs of the GuardDuty member accounts whose findings you want the master account to monitor.
dict
Response Syntax
{
'UnprocessedAccounts': [
{
'AccountId': 'string',
'Result': 'string'
},
]
}
Response Structure
Disables GuardDuty from monitoring findings of the member accounts specified by the account IDs. After running this command, a master GuardDuty account can run StartMonitoringMembers to re-enable GuardDuty to monitor these members’ findings.
See also: AWS API Documentation
Request Syntax
response = client.stop_monitoring_members(
AccountIds=[
'string',
],
DetectorId='string'
)
[REQUIRED] A list of account IDs of the GuardDuty member accounts whose findings you want the master account to stop monitoring.
dict
Response Syntax
{
'UnprocessedAccounts': [
{
'AccountId': 'string',
'Result': 'string'
},
]
}
Response Structure
Unarchives Amazon GuardDuty findings specified by the list of finding IDs.
See also: AWS API Documentation
Request Syntax
response = client.unarchive_findings(
DetectorId='string',
FindingIds=[
'string',
]
)
[REQUIRED] IDs of the findings that you want to unarchive.
dict
Response Syntax
{}
Response Structure
Updates an 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'
)
dict
Response Syntax
{}
Response Structure
Updates the filter specified by the filter name.
See also: AWS API Documentation
Request Syntax
response = client.update_filter(
Action='NOOP'|'ARCHIVE',
Description='string',
DetectorId='string',
FilterName='string',
FindingCriteria={
'Criterion': {
'string': {
'Eq': [
'string',
],
'Gt': 123,
'Gte': 123,
'Lt': 123,
'Lte': 123,
'Neq': [
'string',
]
}
}
},
Rank=123
)
Represents the criteria to be used in the filter for querying findings.
dict
Response Syntax
{
'Name': 'string'
}
Response Structure
Marks specified Amazon GuardDuty findings as useful or not useful.
See also: AWS API Documentation
Request Syntax
response = client.update_findings_feedback(
Comments='string',
DetectorId='string',
Feedback='USEFUL'|'NOT_USEFUL',
FindingIds=[
'string',
]
)
[REQUIRED] IDs of the findings that you want to mark as useful or not useful.
dict
Response Syntax
{}
Response Structure
Updates the IPSet specified by the IPSet ID.
See also: AWS API Documentation
Request Syntax
response = client.update_ip_set(
Activate=True|False,
DetectorId='string',
IpSetId='string',
Location='string',
Name='string'
)
dict
Response Syntax
{}
Response Structure
Updates the ThreatIntelSet specified by ThreatIntelSet ID.
See also: AWS API Documentation
Request Syntax
response = client.update_threat_intel_set(
Activate=True|False,
DetectorId='string',
Location='string',
Name='string',
ThreatIntelSetId='string'
)
dict
Response Syntax
{}
Response Structure
The available paginators are:
paginator = client.get_paginator('list_detectors')
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'
}
)
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'DetectorIds': [
'string',
],
}
Response Structure
paginator = client.get_paginator('list_filters')
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'
}
)
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'FilterNames': [
'string',
],
}
Response Structure
paginator = client.get_paginator('list_findings')
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',
],
'Gt': 123,
'Gte': 123,
'Lt': 123,
'Lte': 123,
'Neq': [
'string',
]
}
}
},
SortCriteria={
'AttributeName': 'string',
'OrderBy': 'ASC'|'DESC'
},
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Represents the criteria used for querying findings.
Represents the criteria used for sorting findings.
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'FindingIds': [
'string',
],
}
Response Structure
paginator = client.get_paginator('list_ip_sets')
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'
}
)
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'IpSetIds': [
'string',
],
}
Response Structure
paginator = client.get_paginator('list_invitations')
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'
}
)
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'Invitations': [
{
'AccountId': 'string',
'InvitationId': 'string',
'InvitedAt': 'string',
'RelationshipStatus': 'string'
},
],
}
Response Structure
paginator = client.get_paginator('list_members')
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'
}
)
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'Members': [
{
'AccountId': 'string',
'DetectorId': 'string',
'Email': 'string',
'InvitedAt': 'string',
'MasterId': 'string',
'RelationshipStatus': 'string',
'UpdatedAt': 'string'
},
],
}
Response Structure
paginator = client.get_paginator('list_threat_intel_sets')
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'
}
)
A dictionary that provides parameters to control pagination.
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.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ThreatIntelSetIds': [
'string',
]
}
Response Structure