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 . clouddirectory ]
update-object-attributes
--directory-arn <value>
--object-reference <value>
--attribute-updates <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>]
--directory-arn
(string)
The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns .
--object-reference
(structure)
The reference that identifies the object.
Selector -> (string)
A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects . You can identify an object in one of the following ways:
- $ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.
- /some/path - Identifies the object based on path
- #SomeBatchReference - Identifies the object in a batch call
Shorthand Syntax:
Selector=string
JSON Syntax:
{
"Selector": "string"
}
--attribute-updates
(list)
The attributes update structure.
(structure)
Structure that contains attribute update information.
ObjectAttributeKey -> (structure)
The key of the attribute being updated.
SchemaArn -> (string)
The Amazon Resource Name (ARN) of the schema that contains the facet and attribute.FacetName -> (string)
The name of the facet that the attribute exists within.Name -> (string)
The name of the attribute.ObjectAttributeAction -> (structure)
The action to perform as part of the attribute update.
ObjectAttributeActionType -> (string)
A type that can be eitherUpdate
orDelete
.ObjectAttributeUpdateValue -> (structure)
The value that you want to update to.
StringValue -> (string)
A string data value.BinaryValue -> (blob)
A binary data value.BooleanValue -> (boolean)
A Boolean data value.NumberValue -> (string)
A number data value.DatetimeValue -> (timestamp)
A date and time value.
Shorthand Syntax:
ObjectAttributeKey={SchemaArn=string,FacetName=string,Name=string},ObjectAttributeAction={ObjectAttributeActionType=string,ObjectAttributeUpdateValue={StringValue=string,BinaryValue=blob,BooleanValue=boolean,NumberValue=string,DatetimeValue=timestamp}} ...
JSON Syntax:
[
{
"ObjectAttributeKey": {
"SchemaArn": "string",
"FacetName": "string",
"Name": "string"
},
"ObjectAttributeAction": {
"ObjectAttributeActionType": "CREATE_OR_UPDATE"|"DELETE",
"ObjectAttributeUpdateValue": {
"StringValue": "string",
"BinaryValue": blob,
"BooleanValue": true|false,
"NumberValue": "string",
"DatetimeValue": timestamp
}
}
}
...
]
--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.
--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.
--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.
--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.