list-related-resources-for-audit-finding¶

Description¶

The related resources of an Audit finding. The following resources can be returned from calling this API:

DEVICE_CERTIFICATE
CA_CERTIFICATE
IOT_POLICY
COGNITO_IDENTITY_POOL
CLIENT_ID
ACCOUNT_SETTINGS
ROLE_ALIAS
IAM_ROLE
ISSUER_CERTIFICATE

Note

This API is similar to DescribeAuditFinding’s RelatedResources but provides pagination and is not limited to 10 resources. When calling DescribeAuditFinding for the intermediate CA revoked for active device certificates check, RelatedResources will not be populated. You must use this API, ListRelatedResourcesForAuditFinding, to list the certificates.

Synopsis¶

  list-related-resources-for-audit-finding
--finding-id <value>
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--finding-id (string) [required]

The finding Id.

Constraints:

min: 1

max: 128

pattern: [a-zA-Z0-9_-]+

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

Constraints:

min: 1

max: 250

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream
off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

relatedResources -> (list)

The related resources.

(structure)

Information about a related resource.

resourceType -> (string)

The type of resource.

Possible values:

DEVICE_CERTIFICATE

CA_CERTIFICATE

IOT_POLICY

COGNITO_IDENTITY_POOL

CLIENT_ID

ACCOUNT_SETTINGS

ROLE_ALIAS

IAM_ROLE

ISSUER_CERTIFICATE

resourceIdentifier -> (structure)

Information that identifies the resource.

deviceCertificateId -> (string)

The ID of the certificate attached to the resource.

Constraints:

min: 64

max: 64

pattern: (0x)?[a-fA-F0-9]+

caCertificateId -> (string)

The ID of the CA certificate used to authorize the certificate.

Constraints:

min: 64

max: 64

pattern: (0x)?[a-fA-F0-9]+

cognitoIdentityPoolId -> (string)

The ID of the Amazon Cognito identity pool.

clientId -> (string)

The client ID.

policyVersionIdentifier -> (structure)

The version of the policy associated with the resource.

policyName -> (string)

The name of the policy.

Constraints:

min: 1

max: 128

pattern: [\w+=,.@-]+

policyVersionId -> (string)

The ID of the version of the policy associated with the resource.

Constraints:

pattern: [0-9]+

account -> (string)

The account with which the resource is associated.

Constraints:

min: 12

max: 12

pattern: [0-9]+

iamRoleArn -> (string)

The ARN of the IAM role that has overly permissive actions.

Constraints:

min: 20

max: 2048

roleAliasArn -> (string)

The ARN of the role alias that has overly permissive actions.

Constraints:

min: 1

max: 2048

issuerCertificateIdentifier -> (structure)

The issuer certificate identifier.

issuerCertificateSubject -> (string)

The subject of the issuer certificate.

Constraints:

max: 1000

pattern: [\p{Graph}\x20]*

issuerId -> (string)

The issuer ID.

Constraints:

max: 64

pattern: (0x)?[a-fA-F0-9]+

issuerCertificateSerialNumber -> (string)

The issuer certificate serial number.

Constraints:

max: 20

pattern: [a-fA-F0-9:]+

deviceCertificateArn -> (string)

The ARN of the identified device certificate.

additionalInfo -> (map)

Other information about the resource.

key -> (string)

value -> (string)

nextToken -> (string)

A token that can be used to retrieve the next set of results, or null for the first API call.

Table of Contents

Feedback

User Guide