[ aws . wellarchitected ]
update-agent-context¶
Synopsis¶
update-agent-context
[--client-token <value>]
--profile-arn <value>
--id <value>
[--title <value>]
[--content <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]
[--cli-error-format <value>]
Options¶
--client-token (string)
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Constraints:
- min:
1- max:
128- pattern:
[\x21-\x7E]+
--profile-arn (string) [required]
The Amazon Resource Name (ARN) of the profile containing the context.
Constraints:
- min:
0- max:
2048- pattern:
arn:aws([a-z0-9-]+)?:wellarchitected:[a-z0-9-]{6,64}:\d{12}:agent-profile/([a-zA-Z0-9_-]+)
--id (string) [required]
The unique identifier of the context to update.
Constraints:
- pattern:
[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
--title (string)
The updated title of the context.
Constraints:
- min:
1- max:
1000- pattern:
(?:(?!\$\{[a-zA-Z]+:)[\P{C}])+
--content (structure)
The updated typed content of the context. The structure contains application-specific fields such as account IDs, Regions, services, and resource types.
accountIds -> (list)
The Amazon Web Services account IDs associated with this application context.
Constraints:
- min:
0- max:
1000(string)
Constraints:
- min:
12- max:
12- pattern:
\d{12}regions -> (list)
The Amazon Web Services Regions where this application operates.
Constraints:
- min:
0- max:
50(string)
Constraints:
- min:
1- max:
64- pattern:
[a-z]{2}(-gov)?-[a-z]+-\d+awsServices -> (list)
The Amazon Web Services services used by this application.
Constraints:
- min:
0- max:
300(string)
Constraints:
- min:
1- max:
256- pattern:
[\P{C}]+resourceTypes -> (list)
The Amazon Web Services resource types relevant to this application.
Constraints:
- min:
0- max:
1500(string)
Constraints:
- min:
1- max:
256- pattern:
[\P{C}]+resourceTags -> (list)
Resource tags used to scope this application context.
Constraints:
- min:
0- max:
20(structure)
A key-value pair representing a resource tag used to scope context content.
key -> (string) [required]
The tag key.
Constraints:
- min:
1- max:
128- pattern:
(?:(?!\$\{[a-zA-Z]+:)[\P{C}])+value -> (string) [required]
The tag value.
Constraints:
- min:
0- max:
256- pattern:
(?:(?!\$\{[a-zA-Z]+:)[\P{C}])*applicationOverview -> (string)
A free-form overview of the application.
Constraints:
- min:
0- max:
10000- pattern:
(?:(?!\$\{[a-zA-Z]+:)[\P{C}\r\n])*industry -> (string)
The industry vertical for this application.
Constraints:
- min:
0- max:
1000- pattern:
(?:(?!\$\{[a-zA-Z]+:)[\P{C}\r\n])*applicationType -> (string)
The type of the application.
Possible values:
SASDESKTOP_APPLICATIONOTHERcriticality -> (string)
The business criticality of the application.
Possible values:
MISSION_CRITICALBUSINESS_CRITICALNON_CRITICALTEST_DEVELOPMENTarchitectureOverview -> (string)
A free-form description of the application architecture.
Constraints:
- min:
0- max:
10000- pattern:
(?:(?!\$\{[a-zA-Z]+:)[\P{C}\r\n])*additionalContext -> (string)
Additional context not captured by other fields.
Constraints:
- min:
0- max:
10000- pattern:
(?:(?!\$\{[a-zA-Z]+:)[\P{C}\r\n])*
Shorthand Syntax:
accountIds=string,string,regions=string,string,awsServices=string,string,resourceTypes=string,string,resourceTags=[{key=string,value=string},{key=string,value=string}],applicationOverview=string,industry=string,applicationType=string,criticality=string,architectureOverview=string,additionalContext=string
JSON Syntax:
{
"accountIds": ["string", ...],
"regions": ["string", ...],
"awsServices": ["string", ...],
"resourceTypes": ["string", ...],
"resourceTags": [
{
"key": "string",
"value": "string"
}
...
],
"applicationOverview": "string",
"industry": "string",
"applicationType": "SAS"|"DESKTOP_APPLICATION"|"OTHER",
"criticality": "MISSION_CRITICAL"|"BUSINESS_CRITICAL"|"NON_CRITICAL"|"TEST_DEVELOPMENT",
"architectureOverview": "string",
"additionalContext": "string"
}
--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
- off
--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.
--cli-error-format (string)
The formatting style for error output. By default, errors are displayed in enhanced format.
- legacy
- json
- yaml
- text
- table
- enhanced
Output¶
context -> (structure)
The updated context summary.
id -> (string) [required]
The unique identifier of the context.
Constraints:
- pattern:
[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}profileArn -> (string) [required]
The Amazon Resource Name (ARN) of the associated profile.
Constraints:
- min:
0- max:
2048- pattern:
arn:aws([a-z0-9-]+)?:wellarchitected:[a-z0-9-]{6,64}:\d{12}:agent-profile/([a-zA-Z0-9_-]+)title -> (string) [required]
The title of the context.
Constraints:
- min:
1- max:
1000- pattern:
(?:(?!\$\{[a-zA-Z]+:)[\P{C}])+contextType -> (string) [required]
The type of the context.
Possible values:
APPLICATIONcontent -> (structure) [required]
The typed content of the context, containing application-specific fields such as account IDs, Regions, services, and resource types.
accountIds -> (list)
The Amazon Web Services account IDs associated with this application context.
Constraints:
- min:
0- max:
1000(string)
Constraints:
- min:
12- max:
12- pattern:
\d{12}regions -> (list)
The Amazon Web Services Regions where this application operates.
Constraints:
- min:
0- max:
50(string)
Constraints:
- min:
1- max:
64- pattern:
[a-z]{2}(-gov)?-[a-z]+-\d+awsServices -> (list)
The Amazon Web Services services used by this application.
Constraints:
- min:
0- max:
300(string)
Constraints:
- min:
1- max:
256- pattern:
[\P{C}]+resourceTypes -> (list)
The Amazon Web Services resource types relevant to this application.
Constraints:
- min:
0- max:
1500(string)
Constraints:
- min:
1- max:
256- pattern:
[\P{C}]+resourceTags -> (list)
Resource tags used to scope this application context.
Constraints:
- min:
0- max:
20(structure)
A key-value pair representing a resource tag used to scope context content.
key -> (string) [required]
The tag key.
Constraints:
- min:
1- max:
128- pattern:
(?:(?!\$\{[a-zA-Z]+:)[\P{C}])+value -> (string) [required]
The tag value.
Constraints:
- min:
0- max:
256- pattern:
(?:(?!\$\{[a-zA-Z]+:)[\P{C}])*applicationOverview -> (string)
A free-form overview of the application.
Constraints:
- min:
0- max:
10000- pattern:
(?:(?!\$\{[a-zA-Z]+:)[\P{C}\r\n])*industry -> (string)
The industry vertical for this application.
Constraints:
- min:
0- max:
1000- pattern:
(?:(?!\$\{[a-zA-Z]+:)[\P{C}\r\n])*applicationType -> (string)
The type of the application.
Possible values:
SASDESKTOP_APPLICATIONOTHERcriticality -> (string)
The business criticality of the application.
Possible values:
MISSION_CRITICALBUSINESS_CRITICALNON_CRITICALTEST_DEVELOPMENTarchitectureOverview -> (string)
A free-form description of the application architecture.
Constraints:
- min:
0- max:
10000- pattern:
(?:(?!\$\{[a-zA-Z]+:)[\P{C}\r\n])*additionalContext -> (string)
Additional context not captured by other fields.
Constraints:
- min:
0- max:
10000- pattern:
(?:(?!\$\{[a-zA-Z]+:)[\P{C}\r\n])*applicationType -> (string)
The type of application described by this context.
Possible values:
SASDESKTOP_APPLICATIONOTHERcriticality -> (string)
The business criticality of the application described by this context.
Possible values:
MISSION_CRITICALBUSINESS_CRITICALNON_CRITICALTEST_DEVELOPMENTcreatedBy -> (string) [required]
The identifier of the user or system that created this context.
Constraints:
- min:
1- max:
128createdAt -> (timestamp) [required]
The timestamp when the context was created.lastModifiedBy -> (string)
The identifier of the user or system that last modified this context.
Constraints:
- min:
1- max:
128lastModifiedAt -> (timestamp)
The timestamp when the context was last modified.