[ aws . mobile ]

describe-project

Description

Gets details about a project in AWS Mobile Hub.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-project
--project-id <value>
[--sync-from-resources | --no-sync-from-resources]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--project-id (string)

Unique project identifier.

--sync-from-resources | --no-sync-from-resources (boolean)

If set to true, causes AWS Mobile Hub to synchronize information from other services, e.g., update state of AWS CloudFormation stacks in the AWS Mobile Hub project.

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

See ‘aws help’ for descriptions of global parameters.

Output

details -> (structure)

Detailed information about an AWS Mobile Hub project.

name -> (string)

Name of the project.

projectId -> (string)

Unique project identifier.

region -> (string)

Default region to use for AWS resource creation in the AWS Mobile Hub project.

state -> (string)

Synchronization state for a project.

createdDate -> (timestamp)

Date the project was created.

lastUpdatedDate -> (timestamp)

Date of the last modification of the project.

consoleUrl -> (string)

Website URL for this project in the AWS Mobile Hub console.

resources -> (list)

List of AWS resources associated with a project.

(structure)

Information about an instance of an AWS resource associated with a project.

type -> (string)

Simplified name for type of AWS resource (e.g., bucket is an Amazon S3 bucket).

name -> (string)

Name of the AWS resource (e.g., for an Amazon S3 bucket this is the name of the bucket).

arn -> (string)

AWS resource name which uniquely identifies the resource in AWS systems.

feature -> (string)

Identifies which feature in AWS Mobile Hub is associated with this AWS resource.

attributes -> (map)

Key-value attribute pairs.

key -> (string)

Key part of key-value attribute pairs.

value -> (string)

Value part of key-value attribute pairs.