Amazon Macie 2017-12-19
- Client: Aws\Macie\MacieClient
- Service ID: macie
- Version: 2017-12-19
This page describes the parameters and results for the operations of the Amazon Macie (2017-12-19), and shows how to use the Aws\Macie\MacieClient object to call the described operations. This documentation is specific to the 2017-12-19 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- AssociateMemberAccount ( array $params = [] )
Associates a specified AWS account with Amazon Macie as a member account.
- AssociateS3Resources ( array $params = [] )
Associates specified S3 resources with Amazon Macie for monitoring and data classification.
- DisassociateMemberAccount ( array $params = [] )
Removes the specified member account from Amazon Macie.
- DisassociateS3Resources ( array $params = [] )
Removes specified S3 resources from being monitored by Amazon Macie.
- ListMemberAccounts ( array $params = [] )
Lists all Amazon Macie member accounts for the current Amazon Macie master account.
- ListS3Resources ( array $params = [] )
Lists all the S3 resources associated with Amazon Macie.
- UpdateS3Resources ( array $params = [] )
Updates the classification types for the specified S3 resources.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
AssociateMemberAccount
$result = $client->associateMemberAccount([/* ... */]); $promise = $client->associateMemberAccountAsync([/* ... */]);
Associates a specified AWS account with Amazon Macie as a member account.
Parameter Syntax
$result = $client->associateMemberAccount([
'memberAccountId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
InvalidInputException:
The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
-
LimitExceededException:
The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.
-
InternalException:
Internal server error.
AssociateS3Resources
$result = $client->associateS3Resources([/* ... */]); $promise = $client->associateS3ResourcesAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->associateS3Resources([
'memberAccountId' => '<string>',
's3Resources' => [ // REQUIRED
[
'bucketName' => '<string>', // REQUIRED
'classificationType' => [ // REQUIRED
'continuous' => 'FULL', // REQUIRED
'oneTime' => 'FULL|NONE', // REQUIRED
],
'prefix' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- memberAccountId
-
- Type: string
The ID of the Amazon Macie member account whose resources you want to associate with Macie.
- s3Resources
-
- Required: Yes
- Type: Array of S3ResourceClassification structures
The S3 resources that you want to associate with Amazon Macie for monitoring and data classification.
Result Syntax
[
'failedS3Resources' => [
[
'errorCode' => '<string>',
'errorMessage' => '<string>',
'failedItem' => [
'bucketName' => '<string>',
'prefix' => '<string>',
],
],
// ...
],
]
Result Details
Members
- failedS3Resources
-
- Type: Array of FailedS3Resource structures
S3 resources that couldn't be associated with Amazon Macie. An error code and an error message are provided for each failed item.
Errors
-
InvalidInputException:
The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
-
AccessDeniedException:
You do not have required permissions to access the requested resource.
-
LimitExceededException:
The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.
-
InternalException:
Internal server error.
DisassociateMemberAccount
$result = $client->disassociateMemberAccount([/* ... */]); $promise = $client->disassociateMemberAccountAsync([/* ... */]);
Removes the specified member account from Amazon Macie.
Parameter Syntax
$result = $client->disassociateMemberAccount([
'memberAccountId' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
InvalidInputException:
The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
-
InternalException:
Internal server error.
DisassociateS3Resources
$result = $client->disassociateS3Resources([/* ... */]); $promise = $client->disassociateS3ResourcesAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->disassociateS3Resources([
'associatedS3Resources' => [ // REQUIRED
[
'bucketName' => '<string>', // REQUIRED
'prefix' => '<string>',
],
// ...
],
'memberAccountId' => '<string>',
]);
Parameter Details
Members
- associatedS3Resources
-
- Required: Yes
- Type: Array of S3Resource structures
The S3 resources (buckets or prefixes) that you want to remove from being monitored and classified by Amazon Macie.
- memberAccountId
-
- Type: string
The ID of the Amazon Macie member account whose resources you want to remove from being monitored by Amazon Macie.
Result Syntax
[
'failedS3Resources' => [
[
'errorCode' => '<string>',
'errorMessage' => '<string>',
'failedItem' => [
'bucketName' => '<string>',
'prefix' => '<string>',
],
],
// ...
],
]
Result Details
Members
- failedS3Resources
-
- Type: Array of FailedS3Resource structures
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.
Errors
-
InvalidInputException:
The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
-
AccessDeniedException:
You do not have required permissions to access the requested resource.
-
InternalException:
Internal server error.
ListMemberAccounts
$result = $client->listMemberAccounts([/* ... */]); $promise = $client->listMemberAccountsAsync([/* ... */]);
Lists all Amazon Macie member accounts for the current Amazon Macie master account.
Parameter Syntax
$result = $client->listMemberAccounts([
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
Use this parameter to indicate the maximum number of items that you want in the response. The default value is 250.
- nextToken
-
- Type: string
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.
Result Syntax
[
'memberAccounts' => [
[
'accountId' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- memberAccounts
-
- Type: Array of MemberAccount structures
A list of the Amazon Macie member accounts returned by the action. The current master account is also included in this list.
- nextToken
-
- Type: 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.
Errors
-
InternalException:
Internal server error.
-
InvalidInputException:
The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
ListS3Resources
$result = $client->listS3Resources([/* ... */]); $promise = $client->listS3ResourcesAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listS3Resources([
'maxResults' => <integer>,
'memberAccountId' => '<string>',
'nextToken' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
Use this parameter to indicate the maximum number of items that you want in the response. The default value is 250.
- memberAccountId
-
- Type: string
The Amazon Macie member account ID whose associated S3 resources you want to list.
- nextToken
-
- Type: string
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.
Result Syntax
[
'nextToken' => '<string>',
's3Resources' => [
[
'bucketName' => '<string>',
'classificationType' => [
'continuous' => 'FULL',
'oneTime' => 'FULL|NONE',
],
'prefix' => '<string>',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: 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.
- s3Resources
-
- Type: Array of S3ResourceClassification structures
A list of the associated S3 resources returned by the action.
Errors
-
InvalidInputException:
The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
-
AccessDeniedException:
You do not have required permissions to access the requested resource.
-
InternalException:
Internal server error.
UpdateS3Resources
$result = $client->updateS3Resources([/* ... */]); $promise = $client->updateS3ResourcesAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->updateS3Resources([
'memberAccountId' => '<string>',
's3ResourcesUpdate' => [ // REQUIRED
[
'bucketName' => '<string>', // REQUIRED
'classificationTypeUpdate' => [ // REQUIRED
'continuous' => 'FULL',
'oneTime' => 'FULL|NONE',
],
'prefix' => '<string>',
],
// ...
],
]);
Parameter Details
Members
- memberAccountId
-
- Type: string
The AWS ID of the Amazon Macie member account whose S3 resources' classification types you want to update.
- s3ResourcesUpdate
-
- Required: Yes
- Type: Array of S3ResourceClassificationUpdate structures
The S3 resources whose classification types you want to update.
Result Syntax
[
'failedS3Resources' => [
[
'errorCode' => '<string>',
'errorMessage' => '<string>',
'failedItem' => [
'bucketName' => '<string>',
'prefix' => '<string>',
],
],
// ...
],
]
Result Details
Members
- failedS3Resources
-
- Type: Array of FailedS3Resource structures
The S3 resources whose classification types can't be updated. An error code and an error message are provided for each failed item.
Errors
-
InvalidInputException:
The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
-
AccessDeniedException:
You do not have required permissions to access the requested resource.
-
InternalException:
Internal server error.
Shapes
AccessDeniedException
Description
You do not have required permissions to access the requested resource.
Members
ClassificationType
Description
The classification type that Amazon Macie applies to the associated S3 resources.
Members
- continuous
-
- Required: Yes
- Type: 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.
- oneTime
-
- Required: Yes
- Type: string
A one-time classification of all of the existing objects in a specified S3 bucket.
ClassificationTypeUpdate
Description
The classification type that Amazon Macie applies to the associated S3 resources. At least one of the classification types (oneTime or continuous) must be specified.
Members
- continuous
-
- Type: 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.
- oneTime
-
- Type: string
A one-time classification of all of the existing objects in a specified S3 bucket.
FailedS3Resource
Description
Includes details about the failed S3 resources.
Members
- errorCode
-
- Type: string
The status code of a failed item.
- errorMessage
-
- Type: string
The error message of a failed item.
- failedItem
-
- Type: S3Resource structure
The failed S3 resources.
InternalException
Description
Internal server error.
Members
InvalidInputException
Description
The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
Members
LimitExceededException
Description
The request was rejected because it attempted to create resources beyond the current AWS account limits. The error code describes the limit exceeded.
Members
MemberAccount
Description
Contains information about the Amazon Macie member account.
Members
S3Resource
Description
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.
Members
S3ResourceClassification
Description
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.
Members
- bucketName
-
- Required: Yes
- Type: string
The name of the S3 bucket that you want to associate with Amazon Macie.
- classificationType
-
- Required: Yes
- Type: ClassificationType structure
The classification type that you want to specify for the resource associated with Amazon Macie.
- prefix
-
- Type: string
The prefix of the S3 bucket that you want to associate with Amazon Macie.
S3ResourceClassificationUpdate
Description
The S3 resources whose classification types you want to update. This data type is used as a request parameter in the UpdateS3Resources action.
Members
- bucketName
-
- Required: Yes
- Type: string
The name of the S3 bucket whose classification types you want to update.
- classificationTypeUpdate
-
- Required: Yes
- Type: ClassificationTypeUpdate structure
The classification type that you want to update for the resource associated with Amazon Macie.
- prefix
-
- Type: string
The prefix of the S3 bucket whose classification types you want to update.
