AWS CLI Command Reference

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 . lakeformation ]

list-resources

Description

Lists the resources registered to be managed by the Data Catalog.

See also: AWS API Documentation

Synopsis

  list-resources
[--filter-condition-list <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json <value>]
[--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>]

Options

--filter-condition-list (list)

Any applicable row-level and/or column-level filtering conditions for the resources.

(structure)

This structure describes the filtering of columns in a table based on a filter condition.

Field -> (string)

The field to filter in the filter condition.

ComparisonOperator -> (string)

The comparison operator used in the filter condition.

StringValueList -> (list)

A string with values used in evaluating the filter condition.

(string)

Shorthand Syntax:

Field=string,ComparisonOperator=string,StringValueList=string,string ...

JSON Syntax:

[
  {
    "Field": "RESOURCE_ARN"|"ROLE_ARN"|"LAST_MODIFIED",
    "ComparisonOperator": "EQ"|"NE"|"LE"|"LT"|"GE"|"GT"|"CONTAINS"|"NOT_CONTAINS"|"BEGINS_WITH"|"IN"|"BETWEEN",
    "StringValueList": ["string", ...]
  }
  ...
]

--max-results (integer)

The maximum number of resource results.

--next-token (string)

A continuation token, if this is not the first call to retrieve these resources.

--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.

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.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--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.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To lists the resources managed by the Lake Formation

The following list-resources example lists the resources matching the condition that is managed by the Lake Formation.

aws lakeformation list-resources \
    --cli-input-json file://input.json

Contents of input.json:

{
    "FilterConditionList": [{
        "Field": "ROLE_ARN",
        "ComparisonOperator": "CONTAINS",
        "StringValueList": [
            "123456789111"
        ]
    }],
    "MaxResults": 10
}

Output:

{
    "ResourceInfoList": [{
            "ResourceArn": "arn:aws:s3:::lf-data-lake-123456789111",
            "RoleArn": "arn:aws:iam::123456789111:role/LF-GlueServiceRole",
            "LastModified": "2022-07-21T02:12:46.669000+00:00"
        },
        {
            "ResourceArn": "arn:aws:s3:::lf-emr-test-123456789111",
            "RoleArn": "arn:aws:iam::123456789111:role/EMRLFS3Role",
            "LastModified": "2022-07-29T16:22:03.211000+00:00"
        }
    ]
}

For more information, see Managing Lake Formation permissions in the AWS Lake Formation Developer Guide.

Output

ResourceInfoList -> (list)

A summary of the data lake resources.

(structure)

A structure containing information about an Lake Formation resource.

ResourceArn -> (string)

The Amazon Resource Name (ARN) of the resource.

RoleArn -> (string)

The IAM role that registered a resource.

LastModified -> (timestamp)

The date and time the resource was last modified.

WithFederation -> (boolean)

Whether or not the resource is a federated resource.

HybridAccessEnabled -> (boolean)

Indicates whether the data access of tables pointing to the location can be managed by both Lake Formation permissions as well as Amazon S3 bucket policies.

NextToken -> (string)

A continuation token, if this is not the first call to retrieve these resources.