AWS CLI Command Reference

[ aws . datazone ]

update-project

Description

Updates the specified project in Amazon DataZone.

See also: AWS API Documentation

Synopsis

  update-project
[--description <value>]
--domain-identifier <value>
[--environment-deployment-details <value>]
[--glossary-terms <value>]
--identifier <value>
[--name <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]

Options

--description (string)

The description to be updated as part of the UpdateProject action.

--domain-identifier (string)

The ID of the Amazon DataZone domain where a project is being updated.

--environment-deployment-details (structure)

The environment deployment details of the project.

environmentFailureReasons -> (map)

Environment failure reasons.

key -> (string)

value -> (list)

(structure)

The failure reasons for the environment deployment.

code -> (string)

The error code for the failure reason for the environment deployment.

message -> (string)

The error message for the failure reason for the environment deployment.

overallDeploymentStatus -> (string)

The overall deployment status of the environment.

Shorthand Syntax:

environmentFailureReasons={KeyName1=[{code=string,message=string},{code=string,message=string}],KeyName2=[{code=string,message=string},{code=string,message=string}]},overallDeploymentStatus=string

JSON Syntax:

{
  "environmentFailureReasons": {"string": [
        {
          "code": "string",
          "message": "string"
        }
        ...
      ]
    ...},
  "overallDeploymentStatus": "PENDING_DEPLOYMENT"|"IN_PROGRESS"|"SUCCESSFUL"|"FAILED_VALIDATION"|"FAILED_DEPLOYMENT"
}

--glossary-terms (list)

The glossary terms to be updated as part of the UpdateProject action.

(string)

Syntax:

"string" "string" ...

--identifier (string)

The identifier of the project that is to be updated.

--name (string)

The name to be updated as part of the UpdateProject action.

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

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

Output

createdAt -> (timestamp)

The timestamp of when the project was created.

createdBy -> (string)

The Amazon DataZone user who created the project.

description -> (string)

The description of the project that is to be updated.

domainId -> (string)

The identifier of the Amazon DataZone domain in which a project is updated.

domainUnitId -> (string)

The ID of the domain unit.

environmentDeploymentDetails -> (structure)

The environment deployment details of the project.

environmentFailureReasons -> (map)

Environment failure reasons.

key -> (string)

value -> (list)

(structure)

The failure reasons for the environment deployment.

code -> (string)

The error code for the failure reason for the environment deployment.

message -> (string)

The error message for the failure reason for the environment deployment.

overallDeploymentStatus -> (string)

The overall deployment status of the environment.

failureReasons -> (list)

Specifies the error message that is returned if the operation cannot be successfully completed.

(structure)

Specifies the error message that is returned if the operation cannot be successfully completed.

code -> (string)

The code of the project deletion error.

message -> (string)

The message of the project deletion error.

glossaryTerms -> (list)

The glossary terms of the project that are to be updated.

(string)

id -> (string)

The identifier of the project that is to be updated.

lastUpdatedAt -> (timestamp)

The timestamp of when the project was last updated.

name -> (string)

The name of the project that is to be updated.

projectProfileId -> (string)

The ID of the project profile.

projectStatus -> (string)

The status of the project.

userParameters -> (list)

The user parameters of the project.

(structure)

The environment configuration user parameters.

environmentConfigurationName -> (string)

The environment configuration name.

environmentParameters -> (list)

The environment parameters.

(structure)

The parameter details of an evironment profile.

name -> (string)

The name of an environment profile parameter.

value -> (string)

The value of an environment profile parameter.
© Copyright 2018, Amazon Web Services. Created using Sphinx.