Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . macie2 ]

get-findings

Description

Retrieves information about one or more findings.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-findings
--finding-ids <value>
[--sort-criteria <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--finding-ids (list)

An array of strings that lists the unique identifiers for the findings to retrieve information about.

Syntax:

"string" "string" ...

--sort-criteria (structure)

The criteria for sorting the results of the request.

Shorthand Syntax:

attributeName=string,orderBy=string

JSON Syntax:

{
  "attributeName": "string",
  "orderBy": "ASC"|"DESC"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

findings -> (list)

An array of objects, one for each finding that meets the criteria specified in the request.

(structure)

Provides information about a finding.

accountId -> (string)

The identifier for the AWS account that the finding applies to. This is typically the account that owns the affected resource.

archived -> (boolean)

Specifies whether the finding is archived.

category -> (string)

The category of the finding. Possible values are: CLASSIFICATION, for a sensitive data finding; and, POLICY, for a policy finding.

classificationDetails -> (structure)

The details of a sensitive data finding. This value is null for a policy finding.

detailedResultsLocation -> (string)

The Amazon Resource Name (ARN) of the file that contains the detailed record, including offsets, for the finding.

jobArn -> (string)

The Amazon Resource Name (ARN) of the classification job that produced the finding.

jobId -> (string)

The unique identifier for the classification job that produced the finding.

result -> (structure)

The status and detailed results of the finding.

customDataIdentifiers -> (structure)

The number of occurrences of the data that produced the finding, and the custom data identifiers that detected the data.

detections -> (list)

The names of the custom data identifiers that detected the data, and the number of occurrences of the data that each identifier detected.

(structure)

Provides information about a custom data identifier that produced a sensitive data finding, and the number of occurrences of the data that it detected for the finding.

arn -> (string)

The Amazon Resource Name (ARN) of the custom data identifier.

count -> (long)

The total number of occurrences of the data that the custom data identifier detected for the finding.

name -> (string)

The name of the custom data identifier.

totalCount -> (long)

The total number of occurrences of the data that was detected by the custom data identifiers and produced the finding.

mimeType -> (string)

The type of content, expressed as a MIME type, that the finding applies to. For example, application/gzip, for a GNU Gzip compressed archive file, or application/pdf, for an Adobe PDF file.

sensitiveData -> (list)

The category and number of occurrences of the sensitive data that produced the finding.

(structure)

Provides information about the category, type, and number of occurrences of sensitive data that produced a finding.

category -> (string)

The category of sensitive data that was detected. For example: FINANCIAL_INFORMATION, for financial information such as credit card numbers; PERSONAL_INFORMATION, for personally identifiable information such as full names and mailing addresses; or, CUSTOM_IDENTIFIER, for data that was detected by a custom data identifier.

detections -> (list)

An array of objects, one for each type of sensitive data that was detected. Each object reports the number of occurrences of a specific type of sensitive data that was detected.

(structure)

Provides information about sensitive data that was detected by managed data identifiers and produced a finding.

count -> (long)

The total number of occurrences of the type of data that was detected.

type -> (string)

The type of data that was detected. For example, AWS_CREDENTIALS, PHONE_NUMBER, or ADDRESS.

totalCount -> (long)

The total number of occurrences of the sensitive data that was detected.

sizeClassified -> (long)

The total size, in bytes, of the data that the finding applies to.

status -> (structure)

The status of the finding.

code -> (string)

The status of the finding, such as COMPLETE.

reason -> (string)

A brief description of the status of the finding. Amazon Macie uses this value to notify you of any errors, warnings, or considerations that might impact your analysis of the finding.

count -> (long)

The total number of occurrences of this finding.

createdAt -> (timestamp)

The date and time, in UTC and extended ISO 8601 format, when the finding was created.

description -> (string)

The description of the finding.

id -> (string)

The unique identifier for the finding. This is a random string that Amazon Macie generates and assigns to a finding when it creates the finding.

partition -> (string)

The AWS partition that Amazon Macie created the finding in.

policyDetails -> (structure)

The details of a policy finding. This value is null for a sensitive data finding.

action -> (structure)

The action that occurred and produced the finding.

actionType -> (string)

The type of action that occurred for the affected resource. This value is typically AWS_API_CALL, which indicates that an entity invoked an API operation for the resource.

apiCallDetails -> (structure)

For the affected resource:

  • The name of the operation that was invoked most recently and produced the finding (api).
  • The first date and time when any operation was invoked and produced the finding (firstSeen).
  • The most recent date and time when the specified operation was invoked and produced the finding (lastSeen).

All date and time values are in UTC and extended ISO 8601 format.

api -> (string)

Reserved for future use.

apiServiceName -> (string)

Reserved for future use.

firstSeen -> (timestamp)

Reserved for future use.

lastSeen -> (timestamp)

Reserved for future use.

actor -> (structure)

The entity that performed the action that produced the finding.

domainDetails -> (structure)

The DNS name of the entity that performed the action on the affected resource.

domainName -> (string)

Reserved for future use.

ipAddressDetails -> (structure)

The IP address of the device that the entity used to perform the action on the affected resource. This object also provides information such as the owner and geographical location for the IP address.

ipAddressV4 -> (string)

Reserved for future use.

ipCity -> (structure)

Reserved for future use.

name -> (string)

Reserved for future use.

ipCountry -> (structure)

Reserved for future use.

code -> (string)

Reserved for future use.

name -> (string)

Reserved for future use.

ipGeoLocation -> (structure)

Reserved for future use.

lat -> (double)

Reserved for future use.

lon -> (double)

Reserved for future use.

ipOwner -> (structure)

Reserved for future use.

asn -> (string)

Reserved for future use.

asnOrg -> (string)

Reserved for future use.

isp -> (string)

Reserved for future use.

org -> (string)

Reserved for future use.

userIdentity -> (structure)

The name and type of entity that performed the action on the affected resource.

assumedRole -> (structure)

Reserved for future use.

accessKeyId -> (string)

Reserved for future use.

accountId -> (string)

Reserved for future use.

arn -> (string)

Reserved for future use.

principalId -> (string)

Reserved for future use.

sessionContext -> (structure)

Reserved for future use.

attributes -> (structure)

The date and time when the credentials were issued, and whether the credentials were authenticated with a multi-factor authentication (MFA) device.

creationDate -> (timestamp)

The date and time, in ISO 8601 format, when the credentials were issued.

mfaAuthenticated -> (boolean)

Specifies whether the credentials were authenticated with a multi-factor authentication (MFA) device.

sessionIssuer -> (structure)

The source and type of credentials that the entity obtained.

accountId -> (string)

The account that owns the entity that was used to get the credentials.

arn -> (string)

The Amazon Resource Name (ARN) of the source account, IAM user, or role that was used to get the credentials.

principalId -> (string)

The internal identifier for the entity that was used to get the credentials.

type -> (string)

The source of the temporary security credentials, such as Root, IAMUser, or Role.

userName -> (string)

The name or alias of the user or role that issued the session. This value is null if the credentials were obtained from a root account that doesn't have an alias.

awsAccount -> (structure)

Reserved for future use.

accountId -> (string)

Reserved for future use.

principalId -> (string)

Reserved for future use.

awsService -> (structure)

Reserved for future use.

invokedBy -> (string)

Reserved for future use.

federatedUser -> (structure)

Reserved for future use.

accessKeyId -> (string)

Reserved for future use.

accountId -> (string)

Reserved for future use.

arn -> (string)

Reserved for future use.

principalId -> (string)

Reserved for future use.

sessionContext -> (structure)

Reserved for future use.

attributes -> (structure)

The date and time when the credentials were issued, and whether the credentials were authenticated with a multi-factor authentication (MFA) device.

creationDate -> (timestamp)

The date and time, in ISO 8601 format, when the credentials were issued.

mfaAuthenticated -> (boolean)

Specifies whether the credentials were authenticated with a multi-factor authentication (MFA) device.

sessionIssuer -> (structure)

The source and type of credentials that the entity obtained.

accountId -> (string)

The account that owns the entity that was used to get the credentials.

arn -> (string)

The Amazon Resource Name (ARN) of the source account, IAM user, or role that was used to get the credentials.

principalId -> (string)

The internal identifier for the entity that was used to get the credentials.

type -> (string)

The source of the temporary security credentials, such as Root, IAMUser, or Role.

userName -> (string)

The name or alias of the user or role that issued the session. This value is null if the credentials were obtained from a root account that doesn't have an alias.

iamUser -> (structure)

Reserved for future use.

accountId -> (string)

Reserved for future use.

arn -> (string)

Reserved for future use.

principalId -> (string)

Reserved for future use.

userName -> (string)

Reserved for future use.

root -> (structure)

Reserved for future use.

accountId -> (string)

Reserved for future use.

arn -> (string)

Reserved for future use.

principalId -> (string)

Reserved for future use.

type -> (string)

Reserved for future use.

region -> (string)

The AWS Region that Amazon Macie created the finding in.

resourcesAffected -> (structure)

The resources that the finding applies to.

s3Bucket -> (structure)

An array of objects, one for each S3 bucket that the finding applies to. Each object provides a set of metadata about an affected S3 bucket.

arn -> (string)

The Amazon Resource Name (ARN) of the bucket.

createdAt -> (timestamp)

The date and time, in UTC and extended ISO 8601 format, when the bucket was created.

defaultServerSideEncryption -> (structure)

The server-side encryption settings for the bucket.

encryptionType -> (string)

The server-side encryption algorithm that's used when storing data in the bucket or object. If encryption is disabled for the bucket or object, this value is NONE.

kmsMasterKeyId -> (string)

The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) master key that's used to encrypt the bucket or object. This value is null if KMS isn't used to encrypt the bucket or object.

name -> (string)

The name of the bucket.

owner -> (structure)

The display name and account identifier for the user who owns the bucket.

displayName -> (string)

The display name of the user who owns the bucket.

id -> (string)

The AWS account ID for the user who owns the bucket.

publicAccess -> (structure)

The permissions settings that determine whether the bucket is publicly accessible.

effectivePermission -> (string)

Specifies whether the bucket is publicly accessible due to the combination of permissions settings that apply to the bucket. Possible values are: PUBLIC, the bucket is publicly accessible; and, NOT_PUBLIC, the bucket isn't publicly accessible.

permissionConfiguration -> (structure)

The account-level and bucket-level permissions for the bucket.

accountLevelPermissions -> (structure)

The account-level permissions settings that apply to the bucket.

blockPublicAccess -> (structure)

The block public access settings for the bucket.

blockPublicAcls -> (boolean)

Specifies whether Amazon S3 blocks public access control lists (ACLs) for the bucket and objects in the bucket.

blockPublicPolicy -> (boolean)

Specifies whether Amazon S3 blocks public bucket policies for the bucket.

ignorePublicAcls -> (boolean)

Specifies whether Amazon S3 ignores public ACLs for the bucket and objects in the bucket.

restrictPublicBuckets -> (boolean)

Specifies whether Amazon S3 restricts public bucket policies for the bucket.

bucketLevelPermissions -> (structure)

The bucket-level permissions settings for the bucket.

accessControlList -> (structure)

The permissions settings of the access control list (ACL) for the bucket. This value is null if an ACL hasn't been defined for the bucket.

allowsPublicReadAccess -> (boolean)

Specifies whether the ACL grants the general public with read access permissions for the bucket.

allowsPublicWriteAccess -> (boolean)

Specifies whether the ACL grants the general public with write access permissions for the bucket.

blockPublicAccess -> (structure)

The block public access settings for the bucket.

blockPublicAcls -> (boolean)

Specifies whether Amazon S3 blocks public access control lists (ACLs) for the bucket and objects in the bucket.

blockPublicPolicy -> (boolean)

Specifies whether Amazon S3 blocks public bucket policies for the bucket.

ignorePublicAcls -> (boolean)

Specifies whether Amazon S3 ignores public ACLs for the bucket and objects in the bucket.

restrictPublicBuckets -> (boolean)

Specifies whether Amazon S3 restricts public bucket policies for the bucket.

bucketPolicy -> (structure)

The permissions settings of the bucket policy for the bucket. This value is null if a bucket policy hasn't been defined for the bucket.

allowsPublicReadAccess -> (boolean)

Specifies whether the bucket policy allows the general public to have read access to the bucket.

allowsPublicWriteAccess -> (boolean)

Specifies whether the bucket policy allows the general public to have write access to the bucket.

tags -> (list)

The tags that are associated with the bucket.

(structure)

Provides information about the tags that are associated with an S3 bucket or object. Each tag consists of a required tag key and an associated tag value.

key -> (string)

One part of a key-value pair that comprises a tag. A tag key is a general label that acts as a category for more specific tag values.

value -> (string)

One part of a key-value pair that comprises a tag. A tag value acts as a descriptor for a tag key. A tag value can be empty or null.

s3Object -> (structure)

An array of objects, one for each S3 object that the finding applies to. Each object provides a set of metadata about an affected S3 object.

bucketArn -> (string)

The Amazon Resource Name (ARN) of the bucket that contains the object.

eTag -> (string)

The entity tag (ETag) that identifies the affected version of the object. If the object was overwritten or changed after Amazon Macie produced the finding, this value might be different from the current ETag for the object.

extension -> (string)

The file extension of the object. If the object doesn't have a file extension, this value is "".

key -> (string)

The full key (name) that's assigned to the object.

lastModified -> (timestamp)

The date and time, in UTC and extended ISO 8601 format, when the object was last modified.

path -> (string)

The path to the object, including the full key (name).

publicAccess -> (boolean)

Specifies whether the object is publicly accessible due to the combination of permissions settings that apply to the object.

serverSideEncryption -> (structure)

The server-side encryption settings for the object.

encryptionType -> (string)

The server-side encryption algorithm that's used when storing data in the bucket or object. If encryption is disabled for the bucket or object, this value is NONE.

kmsMasterKeyId -> (string)

The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) master key that's used to encrypt the bucket or object. This value is null if KMS isn't used to encrypt the bucket or object.

size -> (long)

The total storage size, in bytes, of the object.

storageClass -> (string)

The storage class of the object.

tags -> (list)

The tags that are associated with the object.

(structure)

Provides information about the tags that are associated with an S3 bucket or object. Each tag consists of a required tag key and an associated tag value.

key -> (string)

One part of a key-value pair that comprises a tag. A tag key is a general label that acts as a category for more specific tag values.

value -> (string)

One part of a key-value pair that comprises a tag. A tag value acts as a descriptor for a tag key. A tag value can be empty or null.

versionId -> (string)

The identifier for the affected version of the object.

sample -> (boolean)

Specifies whether the finding is a sample finding. A sample finding is a finding that uses example data to demonstrate what a finding might contain.

schemaVersion -> (string)

The version of the schema that was used to define the data structures in the finding.

severity -> (structure)

The severity of the finding.

description -> (string)

The textual representation of the severity value, such as Low or High.

score -> (long)

The numeric score for the severity value, ranging from 0 (least severe) to 4 (most severe).

title -> (string)

The brief description of the finding.

type -> (string)

The type of the finding.

updatedAt -> (timestamp)

The date and time, in UTC and extended ISO 8601 format, when the finding was last updated. For sensitive data findings, this value is the same as the value for the createdAt property. Sensitive data findings aren't updated.