2020/07/17 - Amazon Macie 2 - 5 updated api methods
Changes This release of the Amazon Macie API includes miscellaneous updates and improvements to the documentation.
{'master': {'relationshipStatus': {'RegionDisabled', 'AccountSuspended'}}}
Retrieves information about the Amazon Macie master account for an account.
See also: AWS API Documentation
Request Syntax
client.get_master_account()
dict
Response Syntax
{
'master': {
'accountId': 'string',
'invitationId': 'string',
'invitedAt': datetime(2015, 1, 1),
'relationshipStatus': 'Enabled'|'Paused'|'Invited'|'Created'|'Removed'|'Resigned'|'EmailVerificationInProgress'|'EmailVerificationFailed'|'RegionDisabled'|'AccountSuspended'
}
}
Response Structure
(dict) --
The request succeeded.
master (dict) --
The AWS account ID for the master account. If the accounts are associated by a Macie membership invitation, this object also provides details about the invitation that was sent and accepted to establish the relationship between the accounts.
accountId (string) --
The AWS account ID for the account that sent the invitation.
invitationId (string) --
The unique identifier for the invitation. Amazon Macie uses this identifier to validate the inviter account with the invitee account.
invitedAt (datetime) --
The date and time, in UTC and extended ISO 8601 format, when the invitation was sent.
relationshipStatus (string) --
The status of the relationship between the account that sent the invitation (inviter account ) and the account that received the invitation (invitee account ).
{'relationshipStatus': {'RegionDisabled', 'AccountSuspended'}}
Retrieves information about a member account that's associated with an Amazon Macie master account.
See also: AWS API Documentation
Request Syntax
client.get_member(
id='string'
)
string
[REQUIRED]
The unique identifier for the Amazon Macie resource or account that the request applies to.
dict
Response Syntax
{
'accountId': 'string',
'arn': 'string',
'email': 'string',
'invitedAt': datetime(2015, 1, 1),
'masterAccountId': 'string',
'relationshipStatus': 'Enabled'|'Paused'|'Invited'|'Created'|'Removed'|'Resigned'|'EmailVerificationInProgress'|'EmailVerificationFailed'|'RegionDisabled'|'AccountSuspended',
'tags': {
'string': 'string'
},
'updatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
The request succeeded.
accountId (string) --
The AWS account ID for the account.
arn (string) --
The Amazon Resource Name (ARN) of the account.
email (string) --
The email address for the account.
invitedAt (datetime) --
The date and time, in UTC and extended ISO 8601 format, when an Amazon Macie membership invitation was last sent to the account. This value is null if a Macie invitation hasn't been sent to the account.
masterAccountId (string) --
The AWS account ID for the master account.
relationshipStatus (string) --
The current status of the relationship between the account and the master account.
tags (dict) --
A map of key-value pairs that identifies the tags (keys and values) that are associated with the member account in Amazon Macie.
(string) --
(string) --
updatedAt (datetime) --
The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the relationship between the account and the master account.
{'findingsFilterListItems': {'action': 'ARCHIVE | NOOP'}}
Retrieves a subset of information about all the findings filters for an account.
See also: AWS API Documentation
Request Syntax
client.list_findings_filters(
maxResults=123,
nextToken='string'
)
integer
The maximum number of items to include in each page of a paginated response.
string
The nextToken string that specifies which page of results to return in a paginated response.
dict
Response Syntax
{
'findingsFilterListItems': [
{
'action': 'ARCHIVE'|'NOOP',
'arn': 'string',
'id': 'string',
'name': 'string',
'tags': {
'string': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
The request succeeded.
findingsFilterListItems (list) --
An array of objects, one for each filter that's associated with the account.
(dict) --
Provides information about a findings filter.
action (string) --
The action that's performed on findings that meet the filter criteria. Possible values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.
arn (string) --
The Amazon Resource Name (ARN) of the filter.
id (string) --
The unique identifier for the filter.
name (string) --
The custom name of the filter.
tags (dict) --
A map of key-value pairs that identifies the tags (keys and values) that are associated with the filter.
(string) --
(string) --
nextToken (string) --
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
{'invitations': {'relationshipStatus': {'RegionDisabled', 'AccountSuspended'}}}
Retrieves information about all the Amazon Macie membership invitations that were received by an account.
See also: AWS API Documentation
Request Syntax
client.list_invitations(
maxResults=123,
nextToken='string'
)
integer
The maximum number of items to include in each page of a paginated response.
string
The nextToken string that specifies which page of results to return in a paginated response.
dict
Response Syntax
{
'invitations': [
{
'accountId': 'string',
'invitationId': 'string',
'invitedAt': datetime(2015, 1, 1),
'relationshipStatus': 'Enabled'|'Paused'|'Invited'|'Created'|'Removed'|'Resigned'|'EmailVerificationInProgress'|'EmailVerificationFailed'|'RegionDisabled'|'AccountSuspended'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
The request succeeded.
invitations (list) --
An array of objects, one for each invitation that was received by the account.
(dict) --
Provides information about an Amazon Macie membership invitation that was received by an account.
accountId (string) --
The AWS account ID for the account that sent the invitation.
invitationId (string) --
The unique identifier for the invitation. Amazon Macie uses this identifier to validate the inviter account with the invitee account.
invitedAt (datetime) --
The date and time, in UTC and extended ISO 8601 format, when the invitation was sent.
relationshipStatus (string) --
The status of the relationship between the account that sent the invitation (inviter account ) and the account that received the invitation (invitee account ).
nextToken (string) --
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
{'members': {'relationshipStatus': {'RegionDisabled', 'AccountSuspended'}}}
Retrieves information about the accounts that are associated with an Amazon Macie master account.
See also: AWS API Documentation
Request Syntax
client.list_members(
maxResults=123,
nextToken='string',
onlyAssociated='string'
)
integer
The maximum number of items to include in each page of a paginated response.
string
The nextToken string that specifies which page of results to return in a paginated response.
string
Specifies which accounts to include in the response, based on the status of an account's relationship with the master account. By default, the response includes only current member accounts. To include all accounts, set the value for this parameter to false.
dict
Response Syntax
{
'members': [
{
'accountId': 'string',
'arn': 'string',
'email': 'string',
'invitedAt': datetime(2015, 1, 1),
'masterAccountId': 'string',
'relationshipStatus': 'Enabled'|'Paused'|'Invited'|'Created'|'Removed'|'Resigned'|'EmailVerificationInProgress'|'EmailVerificationFailed'|'RegionDisabled'|'AccountSuspended',
'tags': {
'string': 'string'
},
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
The request succeeded.
members (list) --
An array of objects, one for each account that's associated with the master account and meets the criteria specified by the onlyAssociated request parameter.
(dict) --
Provides information about an account that's associated with an Amazon Macie master account.
accountId (string) --
The AWS account ID for the account.
arn (string) --
The Amazon Resource Name (ARN) of the account.
email (string) --
The email address for the account.
invitedAt (datetime) --
The date and time, in UTC and extended ISO 8601 format, when an Amazon Macie membership invitation was last sent to the account. This value is null if a Macie invitation hasn't been sent to the account.
masterAccountId (string) --
The AWS account ID for the master account.
relationshipStatus (string) --
The current status of the relationship between the account and the master account.
tags (dict) --
A map of key-value pairs that identifies the tags (keys and values) that are associated with the account in Amazon Macie.
(string) --
(string) --
updatedAt (datetime) --
The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the relationship between the account and the master account.
nextToken (string) --
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.