Returns ResourceNotFoundException for an updateId past the 90-day retention window, indistinguishable in the response from an id that never existed.
See also: AWS API Documentation
get-update
--gateway-id <value>
--update-id <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>]
[--help]
--gateway-id (string) [required]
The unique identifier of the gateway.
Constraints:
- min:
8- max:
32- pattern:
rtb-gw-[a-z0-9-]{1,25}
--update-id (string) [required]
The unique identifier of the update.
Constraints:
- min:
8- max:
64- pattern:
update-[a-z0-9]{1,57}
--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.
--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.
--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.
--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.
--help (boolean)
Display help for the command/subcommand.
update -> (structure)
The update.
updateId -> (string) [required]
The unique identifier of the update.
Constraints:
- min:
8- max:
64- pattern:
update-[a-z0-9]{1,57}type -> (string) [required]
The type of change.
Possible values:
GATEWAY_CONFIG_UPDATELINK_CONFIG_UPDATELINK_FLOW_UPDATEROUTING_RULE_UPDATEstatus -> (string) [required]
The status of the update.
Possible values:
IN_PROGRESSSUCCESSFULFAILEDtarget -> (tagged union structure) [required]
The resource that the update targeted.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:gateway,link,routingRule.gateway -> (structure)
The gateway itself.link -> (structure)
A link on the gateway.
linkId -> (string) [required]
The unique identifier of the link.
Constraints:
- min:
6- max:
30- pattern:
link-[a-z0-9-]{1,25}routingRule -> (structure)
A routing rule on one of the gateway’s links.
linkId -> (string) [required]
The unique identifier of the rule’s link.
Constraints:
- min:
6- max:
30- pattern:
link-[a-z0-9-]{1,25}ruleId -> (string) [required]
Identifier for a routing rule
Constraints:
- min:
6- max:
30- pattern:
rule-[a-z0-9-]{1,25}createdAt -> (timestamp) [required]
The timestamp of when the update was created.parameters -> (tagged union structure)
The changes that the update requested.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:responderGatewayConfig,linkConfig,linkFlow,routingRule.responderGatewayConfig -> (structure)
The requested responder gateway configuration.
description -> (string)
The gateway’s description.clientRoutingPolicy -> (string)
The gateway’s client routing policy.
Possible values:
AVAILABILITY_ZONE_AFFINITYANY_AVAILABILITY_ZONEdomainName -> (string)
The gateway’s domain name.
Constraints:
- min:
1- max:
255- pattern:
(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?)(?:\.(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?))+port -> (integer) [required]
The networking port.protocol -> (string) [required]
The networking protocol.
Possible values:
HTTPHTTPSlistenerConfig -> (structure)
Listener configuration for the protocols (HTTP, HTTPS, or both) accepted by the gateway.
protocols -> (list) [required]
The protocol for connections from clients to the gateway
Constraints:
- min:
1- max:
2(string)
Possible values:
HTTPHTTPStrustStoreConfiguration -> (structure)
Describes the configuration of a trust store.
certificateAuthorityCertificates -> (list) [required]
The certificate authority certificate.
Constraints:
- min:
0- max:
2(string)
Constraints:
- min:
1- max:
2097152managedEndpointConfiguration -> (tagged union structure)
Describes the configuration of a managed endpoint.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:autoScalingGroups,eksEndpoints.autoScalingGroups -> (structure)
Describes the configuration of an auto scaling group.
autoScalingGroupNames -> (list) [required]
The names of the auto scaling group.
(string)
Constraints:
- min:
1- max:
255roleArn -> (string) [required]
The role ARN of the auto scaling group.
Constraints:
- pattern:
arn:aws:iam::[0-9]{12}:role/.{1,2048}healthCheckConfig -> (structure)
The health check configuration for the Auto Scaling group managed endpoint.
port -> (integer) [required]
The port to use for health check probes. Valid range is 80 to 65535.
Constraints:
- min:
80- max:
65535path -> (string) [required]
The destination path for the health check request. Must start with
/.Constraints:
- min:
1- max:
128- pattern:
/.*protocol -> (string)
The protocol to use for health check probes.
Possible values:
HTTPHTTPStimeoutMs -> (integer)
The timeout for each health check probe, in milliseconds. Valid range is 100 to 5000.
Constraints:
- min:
100- max:
5000intervalSeconds -> (integer)
The interval between health check probes, in seconds. Valid range is 5 to 60.
Constraints:
- min:
5- max:
60statusCodeMatcher -> (string)
The expected HTTP status code or status code pattern from healthy instances. Supports a single code (for example,
200), a range (for example,200-299), or a comma-separated list (for example,200,204).Constraints:
- min:
1- max:
64healthyThresholdCount -> (integer)
The number of consecutive successful health checks required before an instance is considered healthy. Valid range is 2 to 10.
Constraints:
- min:
2- max:
10unhealthyThresholdCount -> (integer)
The number of consecutive failed health checks required before an instance is considered unhealthy. Valid range is 2 to 10.
Constraints:
- min:
2- max:
10eksEndpoints -> (structure)
Describes the configuration of an Amazon Elastic Kubernetes Service endpoint.
endpointsResourceName -> (string) [required]
The name of the endpoint resource.
Constraints:
- min:
2- max:
63- pattern:
[A-Za-z0-9][A-Za-z0-9-]{0,61}[A-Za-z0-9]endpointsResourceNamespace -> (string) [required]
The namespace of the endpoint resource.
Constraints:
- min:
2- max:
63- pattern:
[A-Za-z0-9][A-Za-z0-9-]{0,61}[A-Za-z0-9]clusterApiServerEndpointUri -> (string) [required]
The URI of the cluster API server endpoint.
Constraints:
- min:
0- max:
255- pattern:
(https|http)://(?:[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?)(?:\.(?:[A-Za-z0-9](?:[A-Za-z0-9-]{0,61}[A-Za-z0-9])?))+clusterApiServerCaCertificateChain -> (string) [required]
The CA certificate chain of the cluster API server.
Constraints:
- min:
1- max:
2097152clusterName -> (string) [required]
The name of the cluster.
Constraints:
- min:
2- max:
63- pattern:
[A-Za-z0-9][A-Za-z0-9-]{0,61}[A-Za-z0-9]roleArn -> (string) [required]
The role ARN for the cluster.
Constraints:
- pattern:
arn:aws:iam::[0-9]{12}:role/.{1,2048}linkConfig -> (structure)
The requested link configuration.
logSettings -> (structure)
Describes the settings for a link log.
applicationLogs -> (structure) [required]
Describes the configuration of a link application log.
sampling -> (structure) [required]
Describes a link application log sample.
errorLog -> (double) [required]
An error log entry.
Constraints:
- min:
0.0- max:
100.0filterLog -> (double) [required]
A filter log entry.
Constraints:
- min:
0.0- max:
100.0timeoutInMillis -> (long)
The timeout value in milliseconds.
Constraints:
- min:
100- max:
5000linkFlow -> (tagged union structure)
The requested link flow.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:modules,flows.modules -> (list)
The requested modules.
(structure)
Describes the configuration of a module.
version -> (string)
The version of the module.
Constraints:
- min:
1- max:
25- pattern:
[a-z0-9-]{1,25}name -> (string) [required]
The name of the module.
Constraints:
- min:
0- max:
255- pattern:
[A-Za-z0-9 -]+dependsOn -> (list)
The dependencies of the module.
(string)
Constraints:
- min:
0- max:
255- pattern:
[A-Za-z0-9 -]+moduleParameters -> (tagged union structure)
Describes the parameters of a module.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:noBid,openRtbAttribute,rateLimiter.noBid -> (structure)
Describes the parameters of a no bid module.
reason -> (string)
The reason description.
Constraints:
- min:
1- max:
50- pattern:
[a-zA-Z0-9]*reasonCode -> (integer)
The reason code.
Constraints:
- min:
0- max:
10passThroughPercentage -> (float)
The pass through percentage.
Constraints:
- min:
0- max:
100openRtbAttribute -> (structure)
Describes the parameters of an open RTB attribute module.
filterType -> (string) [required]
The filter type.
Possible values:
INCLUDEEXCLUDEfilterConfiguration -> (list) [required]
Describes the configuration of a filter.
(structure)
Describes the configuration of a filter.
criteria -> (list) [required]
Describes the criteria for a filter.
(structure)
Describes the criteria for a filter.
path -> (string) [required]
The path to filter.values -> (list) [required]
The value to filter.
Constraints:
- min:
1(string)
action -> (tagged union structure) [required]
Describes a bid action.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:noBid,headerTag.noBid -> (structure)
Describes a no bid action.
noBidReasonCode -> (integer)
The reason code for the no bid action.
Constraints:
- min:
0headerTag -> (structure)
Describes the header tag for a bid action.
name -> (string) [required]
The name of the bid action.value -> (string) [required]
The value of the bid action.holdbackPercentage -> (float) [required]
The hold back percentage.
Constraints:
- min:
0- max:
100rateLimiter -> (structure)
Describes the parameters of a rate limit.
tps -> (float)
The transactions per second rate limit.flows -> (list)
A link’s flows: at most one.
Constraints:
- min:
0- max:
1(structure)
One flow on a link: a set of modules that runs on the link’s bid requests.
name -> (string) [required]
The flow’s name, unique within the link.
Constraints:
- min:
1- max:
64- pattern:
[A-Za-z0-9][A-Za-z0-9-]*pipeline -> (tagged union structure) [required]
The pipeline that the flow’s modules run in. In a sequential pipeline, each module sees the previous module’s output. In a phased pipeline, a phase’s modules see the prior phase’s output, not each other’s.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:sequential,phased.sequential -> (structure)
Modules run in list order. Use it when each module needs the previous module’s output.
modules -> (list) [required]
In execution order.
Constraints:
- min:
1- max:
8(structure)
A version attached to a flow, with its settings.
name -> (string) [required]
The module’s name, unique within the flow.
Constraints:
- min:
1- max:
64- pattern:
[A-Za-z0-9][A-Za-z0-9-]*moduleVersionArn -> (string) [required]
The version to attach. It must be ACTIVE and available to you (see ListAvailableModuleVersions). You can keep a version that’s already in the link’s flows after it’s deprecated, but you can’t give it a higher share of traffic.
Constraints:
- min:
0- max:
1011- pattern:
arn:aws[a-zA-Z-]*:rtbfabric:[a-z0-9-]+::modules/module-[a-zA-Z0-9]{1,25}/versions/(0|[1-9]\d{0,9})\.(0|[1-9]\d{0,9})\.(0|[1-9]\d{0,9})selectedActions -> (list)
The capabilities to turn on, chosen from the version’s
configurableActions. If the version exposes one, it’s the default. If the version exposes more than one, this field is required. If it exposes none, omit this field.Constraints:
- min:
1- max:
16(string)
A capability that you can turn on when you attach a version, such as FILTER or OBSERVE. Each capability needs a minimum permission.
Possible values:
FILTERENRICH_REQUEST_EXTENRICH_REQUEST_HEADERSOBSERVEfailureMode -> (string)
Specifies what happens when the module fails – when its call fails or times out, or when an express module’s dataset is stale. The default is OPEN.
Possible values:
OPENCLOSEDactivationPercentage -> (float)
The percentage of the flow’s requests that the module runs on. The flow skips the module on the rest of the requests. The default is 100.
Constraints:
- min:
0- max:
100configurationValues -> (string)
RTB Fabric validates the value against the version’s
configurationSchemaand rejects a value that fails with ValidationException. Omit it when the schema is empty or fully defaulted.Constraints:
- min:
1- max:
10240phased -> (structure)
Phases run in order; a phase’s modules run concurrently on the same input. Use it when a phase’s modules don’t depend on each other.
phases -> (list) [required]
At most 8 modules in total across the phases; more fails with ValidationException.
Constraints:
- min:
1- max:
8(structure)
One phase of a phased pipeline. Its modules run concurrently on the previous phase’s output.
modules -> (list) [required]
At most one MUTATE_REQUEST_BODY module.
Constraints:
- min:
1- max:
8(structure)
A version attached to a flow, with its settings.
name -> (string) [required]
The module’s name, unique within the flow.
Constraints:
- min:
1- max:
64- pattern:
[A-Za-z0-9][A-Za-z0-9-]*moduleVersionArn -> (string) [required]
The version to attach. It must be ACTIVE and available to you (see ListAvailableModuleVersions). You can keep a version that’s already in the link’s flows after it’s deprecated, but you can’t give it a higher share of traffic.
Constraints:
- min:
0- max:
1011- pattern:
arn:aws[a-zA-Z-]*:rtbfabric:[a-z0-9-]+::modules/module-[a-zA-Z0-9]{1,25}/versions/(0|[1-9]\d{0,9})\.(0|[1-9]\d{0,9})\.(0|[1-9]\d{0,9})selectedActions -> (list)
The capabilities to turn on, chosen from the version’s
configurableActions. If the version exposes one, it’s the default. If the version exposes more than one, this field is required. If it exposes none, omit this field.Constraints:
- min:
1- max:
16(string)
A capability that you can turn on when you attach a version, such as FILTER or OBSERVE. Each capability needs a minimum permission.
Possible values:
FILTERENRICH_REQUEST_EXTENRICH_REQUEST_HEADERSOBSERVEfailureMode -> (string)
Specifies what happens when the module fails – when its call fails or times out, or when an express module’s dataset is stale. The default is OPEN.
Possible values:
OPENCLOSEDactivationPercentage -> (float)
The percentage of the flow’s requests that the module runs on. The flow skips the module on the rest of the requests. The default is 100.
Constraints:
- min:
0- max:
100configurationValues -> (string)
RTB Fabric validates the value against the version’s
configurationSchemaand rejects a value that fails with ValidationException. Omit it when the schema is empty or fully defaulted.Constraints:
- min:
1- max:
10240routingRule -> (structure)
The requested routing rule.
priority -> (integer) [required]
WAF-style evaluation priority. Lower number = evaluated first (priority 1 before 10). Gaps are allowed (1, 10, 20 is valid). Must be between 1 and 1000 inclusive. Uniqueness per link among non-deleted rules is enforced at the API layer (HTTP 409 on conflict).
Constraints:
- min:
1- max:
1000conditions -> (structure) [required]
The conditions for a routing rule. All specified fields must match for the rule to apply (AND logic). At least one condition field must be set.
hostHeader -> (string)
The exact host header value to match.
Constraints:
- min:
1- max:
255- pattern:
[A-Za-z0-9._~-]+hostHeaderWildcard -> (string)
A wildcard pattern for host header matching (for example,
*.example.com).Constraints:
- min:
3- max:
255- pattern:
[A-Za-z0-9._~*-]+pathPrefix -> (string)
The path prefix to match. The request path must start with this value. Must start with
/.Constraints:
- min:
1- max:
128- pattern:
/[A-Za-z0-9._~/-]*pathExact -> (string)
The exact path to match. Must start with
/.Constraints:
- min:
1- max:
128- pattern:
/[A-Za-z0-9._~/-]*queryStringEquals -> (structure)
A query string key-value pair that must be present and match exactly.
key -> (string) [required]
The key of the query string parameter to match. Must contain only RFC 3986 unreserved characters.
Constraints:
- min:
1- max:
128- pattern:
[A-Za-z0-9._~-]+value -> (string) [required]
The value of the query string parameter to match. Must contain only RFC 3986 unreserved characters.
Constraints:
- min:
1- max:
128- pattern:
[A-Za-z0-9._~-]+queryStringExists -> (string)
A query string key that must be present in the request (any value is accepted).
Constraints:
- min:
1- max:
128- pattern:
[A-Za-z0-9._~-]+errorDetails -> (list)
The causes of the failure. Present only when the update has failed.
Constraints:
- min:
0- max:
10(structure)
Describes one cause of a failure of a resource or an update, with an error code, a description, and the IDs of the resources involved.
code -> (string) [required]
The error code for what failed.
Possible values:
VPC_NOT_FOUNDEC2_SUBNET_NOT_FOUNDEC2_SECURITY_GROUP_NOT_FOUNDEC2_SUBNET_IP_EXHAUSTIONIAM_ASSUME_ROLE_ACCESS_DENIEDINTERNAL_ERRORmessage -> (string) [required]
A description of the failure.
Constraints:
- min:
0- max:
1024resourceIds -> (list)
The IDs of the resources involved, such as a subnet or security group.
Constraints:
- min:
0- max:
10(string)
Constraints:
- min:
1- max:
64