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

list-projects

Description

Gets a list of the projects in an Amazon Web Services account.

See also: AWS API Documentation

Synopsis

  list-projects
[--creation-time-after <value>]
[--creation-time-before <value>]
[--max-results <value>]
[--name-contains <value>]
[--next-token <value>]
[--sort-by <value>]
[--sort-order <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

--creation-time-after (timestamp)

A filter that returns the projects that were created after a specified time.

--creation-time-before (timestamp)

A filter that returns the projects that were created before a specified time.

--max-results (integer)

The maximum number of projects to return in the response.

--name-contains (string)

A filter that returns the projects whose name contains a specified string.

--next-token (string)

If the result of the previous ListProjects request was truncated, the response includes a NextToken . To retrieve the next set of projects, use the token in the next request.

--sort-by (string)

The field by which to sort results. The default is CreationTime .

Possible values:

• Name
• CreationTime

--sort-order (string)

The sort order for results. The default is Ascending .

Possible values:

• Ascending
• Descending

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

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

Output

ProjectSummaryList -> (list)

A list of summaries of projects.

(structure)

Information about a project.

ProjectName -> (string)

The name of the project.

ProjectDescription -> (string)

The description of the project.

ProjectArn -> (string)

The Amazon Resource Name (ARN) of the project.

ProjectId -> (string)

The ID of the project.

CreationTime -> (timestamp)

The time that the project was created.

ProjectStatus -> (string)

The status of the project.

NextToken -> (string)

If the result of the previous ListCompilationJobs request was truncated, the response includes a NextToken . To retrieve the next set of model compilation jobs, use the token in the next request.