AWS API Changes

2018/06/21 - Amazon Macie - 7 new api methods

Changes Amazon Macie is a security service that uses machine learning to automatically discover, classify, and protect sensitive data in AWS. With this release, we are launching the following Macie HTTPS API operations: AssociateMemberAccount, AssociateS3Resources, DisassociateMemberAccount, DisassociateS3Resources, ListMemberAccounts, ListS3Resources, and UpdateS3Resources. With these API operations you can issue HTTPS requests directly to the service.

AssociateS3Resources (new)

Link ¶

Associates specified S3 resources with Amazon Macie for monitoring and data classification. If memberAccountId isn't specified, the action associates specified S3 resources with Macie for the current master account. If memberAccountId is specified, the action associates specified S3 resources with Macie for the specified member account.

See also: AWS API Documentation

Request Syntax

client.associate_s3_resources(
    memberAccountId='string',
    s3Resources=[
        {
            'bucketName': 'string',
            'prefix': 'string',
            'classificationType': {
                'oneTime': 'FULL'|'NONE',
                'continuous': 'FULL'
            }
        },
    ]
)

type memberAccountId

string

param memberAccountId

The ID of the Amazon Macie member account whose resources you want to associate with Macie.

type s3Resources

list

param s3Resources

[REQUIRED]

The S3 resources that you want to associate with Amazon Macie for monitoring and data classification.

(dict) --

The S3 resources that you want to associate with Amazon Macie for monitoring and data classification. This data type is used as a request parameter in the AssociateS3Resources action and a response parameter in the ListS3Resources action.
- bucketName (string) -- [REQUIRED]
  
  The name of the S3 bucket that you want to associate with Amazon Macie.
- prefix (string) --
  
  The prefix of the S3 bucket that you want to associate with Amazon Macie.
- classificationType (dict) -- [REQUIRED]
  
  The classification type that you want to specify for the resource associated with Amazon Macie.
  - oneTime (string) -- [REQUIRED]
    
    A one-time classification of all of the existing objects in a specified S3 bucket.
  - continuous (string) -- [REQUIRED]
    
    A continuous classification of the objects that are added to a specified S3 bucket. Amazon Macie begins performing continuous classification after a bucket is successfully associated with Amazon Macie.

rtype

dict

returns

Response Syntax

{
    'failedS3Resources': [
        {
            'failedItem': {
                'bucketName': 'string',
                'prefix': 'string'
            },
            'errorCode': 'string',
            'errorMessage': 'string'
        },
    ]
}

Response Structure

(dict) --
- failedS3Resources (list) --
  
  S3 resources that couldn't be associated with Amazon Macie. An error code and an error message are provided for each failed item.
  - (dict) --
    
    Includes details about the failed S3 resources.
    - failedItem (dict) --
      
      The failed S3 resources.
      - bucketName (string) --
        
        The name of the S3 bucket.
      - prefix (string) --
        
        The prefix of the S3 bucket.
    - errorCode (string) --
      
      The status code of a failed item.
    - errorMessage (string) --
      
      The error message of a failed item.

AssociateMemberAccount (new)

Link ¶

Associates a specified AWS account with Amazon Macie as a member account.

See also: AWS API Documentation

Request Syntax

client.associate_member_account(
    memberAccountId='string'
)

type memberAccountId

string

param memberAccountId

[REQUIRED]

The ID of the AWS account that you want to associate with Amazon Macie as a member account.

returns

None

DisassociateMemberAccount (new)

Link ¶

Removes the specified member account from Amazon Macie.

See also: AWS API Documentation

Request Syntax

client.disassociate_member_account(
    memberAccountId='string'
)

type memberAccountId

string

param memberAccountId

[REQUIRED]

The ID of the member account that you want to remove from Amazon Macie.

returns

None

DisassociateS3Resources (new)

Link ¶

Removes specified S3 resources from being monitored by Amazon Macie. If memberAccountId isn't specified, the action removes specified S3 resources from Macie for the current master account. If memberAccountId is specified, the action removes specified S3 resources from Macie for the specified member account.

See also: AWS API Documentation

Request Syntax

client.disassociate_s3_resources(
    memberAccountId='string',
    associatedS3Resources=[
        {
            'bucketName': 'string',
            'prefix': 'string'
        },
    ]
)

type memberAccountId

string

param memberAccountId

The ID of the Amazon Macie member account whose resources you want to remove from being monitored by Amazon Macie.

type associatedS3Resources

list

param associatedS3Resources

[REQUIRED]

The S3 resources (buckets or prefixes) that you want to remove from being monitored and classified by Amazon Macie.

(dict) --

Contains information about the S3 resource. This data type is used as a request parameter in the DisassociateS3Resources action and can be used as a response parameter in the AssociateS3Resources and UpdateS3Resources actions.
- bucketName (string) -- [REQUIRED]
  
  The name of the S3 bucket.
- prefix (string) --
  
  The prefix of the S3 bucket.

rtype

dict

returns

Response Syntax

{
    'failedS3Resources': [
        {
            'failedItem': {
                'bucketName': 'string',
                'prefix': 'string'
            },
            'errorCode': 'string',
            'errorMessage': 'string'
        },
    ]
}

Response Structure

(dict) --
- failedS3Resources (list) --
  
  S3 resources that couldn't be removed from being monitored and classified by Amazon Macie. An error code and an error message are provided for each failed item.
  - (dict) --
    
    Includes details about the failed S3 resources.
    - failedItem (dict) --
      
      The failed S3 resources.
      - bucketName (string) --
        
        The name of the S3 bucket.
      - prefix (string) --
        
        The prefix of the S3 bucket.
    - errorCode (string) --
      
      The status code of a failed item.
    - errorMessage (string) --
      
      The error message of a failed item.

ListS3Resources (new)

Link ¶

Lists all the S3 resources associated with Amazon Macie. If memberAccountId isn't specified, the action lists the S3 resources associated with Amazon Macie for the current master account. If memberAccountId is specified, the action lists the S3 resources associated with Amazon Macie for the specified member account.

See also: AWS API Documentation

Request Syntax

client.list_s3_resources(
    memberAccountId='string',
    nextToken='string',
    maxResults=123
)

type memberAccountId

string

param memberAccountId

The Amazon Macie member account ID whose associated S3 resources you want to list.

type nextToken

string

param nextToken

Use this parameter when paginating results. Set its value to null on your first call to the ListS3Resources action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data.

type maxResults

integer

param maxResults

Use this parameter to indicate the maximum number of items that you want in the response. The default value is 250.

rtype

dict

returns

Response Syntax

{
    's3Resources': [
        {
            'bucketName': 'string',
            'prefix': 'string',
            'classificationType': {
                'oneTime': 'FULL'|'NONE',
                'continuous': 'FULL'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- s3Resources (list) --
  
  A list of the associated S3 resources returned by the action.
  - (dict) --
    
    The S3 resources that you want to associate with Amazon Macie for monitoring and data classification. This data type is used as a request parameter in the AssociateS3Resources action and a response parameter in the ListS3Resources action.
    - bucketName (string) --
      
      The name of the S3 bucket that you want to associate with Amazon Macie.
    - prefix (string) --
      
      The prefix of the S3 bucket that you want to associate with Amazon Macie.
    - classificationType (dict) --
      
      The classification type that you want to specify for the resource associated with Amazon Macie.
      - oneTime (string) --
        
        A one-time classification of all of the existing objects in a specified S3 bucket.
      - continuous (string) --
        
        A continuous classification of the objects that are added to a specified S3 bucket. Amazon Macie begins performing continuous classification after a bucket is successfully associated with Amazon Macie.
- nextToken (string) --
  
  When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.

ListMemberAccounts (new)

Link ¶

Lists all Amazon Macie member accounts for the current Amazon Macie master account.

See also: AWS API Documentation

Request Syntax

client.list_member_accounts(
    nextToken='string',
    maxResults=123
)

type nextToken

string

param nextToken

Use this parameter when paginating results. Set the value of this parameter to null on your first call to the ListMemberAccounts action. Subsequent calls to the action fill nextToken in the request with the value of nextToken from the previous response to continue listing data.

type maxResults

integer

param maxResults

Use this parameter to indicate the maximum number of items that you want in the response. The default value is 250.

rtype

dict

returns

Response Syntax

{
    'memberAccounts': [
        {
            'accountId': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- memberAccounts (list) --
  
  A list of the Amazon Macie member accounts returned by the action. The current master account is also included in this list.
  - (dict) --
    
    Contains information about the Amazon Macie member account.
    - accountId (string) --
      
      The AWS account ID of the Amazon Macie member account.
- nextToken (string) --
  
  When a response is generated, if there is more data to be listed, this parameter is present in the response and contains the value to use for the nextToken parameter in a subsequent pagination request. If there is no more data to be listed, this parameter is set to null.

UpdateS3Resources (new)

Link ¶

Updates the classification types for the specified S3 resources. If memberAccountId isn't specified, the action updates the classification types of the S3 resources associated with Amazon Macie for the current master account. If memberAccountId is specified, the action updates the classification types of the S3 resources associated with Amazon Macie for the specified member account.

See also: AWS API Documentation

Request Syntax

client.update_s3_resources(
    memberAccountId='string',
    s3ResourcesUpdate=[
        {
            'bucketName': 'string',
            'prefix': 'string',
            'classificationTypeUpdate': {
                'oneTime': 'FULL'|'NONE',
                'continuous': 'FULL'
            }
        },
    ]
)

type memberAccountId

string

param memberAccountId

The AWS ID of the Amazon Macie member account whose S3 resources' classification types you want to update.

type s3ResourcesUpdate

list

param s3ResourcesUpdate

[REQUIRED]

The S3 resources whose classification types you want to update.

(dict) --

The S3 resources whose classification types you want to update. This data type is used as a request parameter in the UpdateS3Resources action.
- bucketName (string) -- [REQUIRED]
  
  The name of the S3 bucket whose classification types you want to update.
- prefix (string) --
  
  The prefix of the S3 bucket whose classification types you want to update.
- classificationTypeUpdate (dict) -- [REQUIRED]
  
  The classification type that you want to update for the resource associated with Amazon Macie.
  - oneTime (string) --
    
    A one-time classification of all of the existing objects in a specified S3 bucket.
  - continuous (string) --
    
    A continuous classification of the objects that are added to a specified S3 bucket. Amazon Macie begins performing continuous classification after a bucket is successfully associated with Amazon Macie.

rtype

dict

returns

Response Syntax

{
    'failedS3Resources': [
        {
            'failedItem': {
                'bucketName': 'string',
                'prefix': 'string'
            },
            'errorCode': 'string',
            'errorMessage': 'string'
        },
    ]
}

Response Structure

(dict) --
- failedS3Resources (list) --
  
  The S3 resources whose classification types can't be updated. An error code and an error message are provided for each failed item.
  - (dict) --
    
    Includes details about the failed S3 resources.
    - failedItem (dict) --
      
      The failed S3 resources.
      - bucketName (string) --
        
        The name of the S3 bucket.
      - prefix (string) --
        
        The prefix of the S3 bucket.
    - errorCode (string) --
      
      The status code of a failed item.
    - errorMessage (string) --
      
      The error message of a failed item.