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.
Gets information about the traffic policy instances that you created by using the current Amazon Web Services account.
UpdateTrafficPolicyInstance
request, there's a brief delay while Amazon Route 53 creates the resource record sets that are specified in the traffic policy definition. For more information, see the State
response element.Route 53 returns a maximum of 100 items in each response. If you have a lot of traffic policy instances, you can use the MaxItems
parameter to list them in groups of up to 100.
See also: AWS API Documentation
list-traffic-policy-instances
[--hosted-zone-id-marker <value>]
[--traffic-policy-instance-name-marker <value>]
[--traffic-policy-instance-type-marker <value>]
[--max-items <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>]
--hosted-zone-id-marker
(string)
If the value of
IsTruncated
in the previous response wastrue
, you have more traffic policy instances. To get more traffic policy instances, submit anotherListTrafficPolicyInstances
request. For the value ofHostedZoneId
, specify the value ofHostedZoneIdMarker
from the previous response, which is the hosted zone ID of the first traffic policy instance in the next group of traffic policy instances.If the value of
IsTruncated
in the previous response wasfalse
, there are no more traffic policy instances to get.
--traffic-policy-instance-name-marker
(string)
If the value of
IsTruncated
in the previous response wastrue
, you have more traffic policy instances. To get more traffic policy instances, submit anotherListTrafficPolicyInstances
request. For the value oftrafficpolicyinstancename
, specify the value ofTrafficPolicyInstanceNameMarker
from the previous response, which is the name of the first traffic policy instance in the next group of traffic policy instances.If the value of
IsTruncated
in the previous response wasfalse
, there are no more traffic policy instances to get.
--traffic-policy-instance-type-marker
(string)
If the value of
IsTruncated
in the previous response wastrue
, you have more traffic policy instances. To get more traffic policy instances, submit anotherListTrafficPolicyInstances
request. For the value oftrafficpolicyinstancetype
, specify the value ofTrafficPolicyInstanceTypeMarker
from the previous response, which is the type of the first traffic policy instance in the next group of traffic policy instances.If the value of
IsTruncated
in the previous response wasfalse
, there are no more traffic policy instances to get.Possible values:
SOA
A
TXT
NS
CNAME
MX
NAPTR
PTR
SRV
SPF
AAAA
CAA
DS
TLSA
SSHFP
SVCB
HTTPS
--max-items
(string)
The maximum number of traffic policy instances that you want Amazon Route 53 to return in response to aListTrafficPolicyInstances
request. If you have more thanMaxItems
traffic policy instances, the value of theIsTruncated
element in the response istrue
, and the values ofHostedZoneIdMarker
,TrafficPolicyInstanceNameMarker
, andTrafficPolicyInstanceTypeMarker
represent the first traffic policy instance in the next group ofMaxItems
traffic policy instances.
--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.
TrafficPolicyInstances -> (list)
A list that contains one
TrafficPolicyInstance
element for each traffic policy instance that matches the elements in the request.(structure)
A complex type that contains settings for the new traffic policy instance.
Id -> (string)
The ID that Amazon Route 53 assigned to the new traffic policy instance.HostedZoneId -> (string)
The ID of the hosted zone that Amazon Route 53 created resource record sets in.Name -> (string)
The DNS name, such as www.example.com, for which Amazon Route 53 responds to queries by using the resource record sets that are associated with this traffic policy instance.TTL -> (long)
The TTL that Amazon Route 53 assigned to all of the resource record sets that it created in the specified hosted zone.State -> (string)
The value of
State
is one of the following values:AppliedAmazon Route 53 has finished creating resource record sets, and changes have propagated to all Route 53 edge locations.
CreatingRoute 53 is creating the resource record sets. Use
GetTrafficPolicyInstance
to confirm that theCreateTrafficPolicyInstance
request completed successfully.FailedRoute 53 wasn't able to create or update the resource record sets. When the value of
State
isFailed
, seeMessage
for an explanation of what caused the request to fail.Message -> (string)
IfState
isFailed
, an explanation of the reason for the failure. IfState
is another value,Message
is empty.TrafficPolicyId -> (string)
The ID of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.TrafficPolicyVersion -> (integer)
The version of the traffic policy that Amazon Route 53 used to create resource record sets in the specified hosted zone.TrafficPolicyType -> (string)
The DNS type that Amazon Route 53 assigned to all of the resource record sets that it created for this traffic policy instance.
HostedZoneIdMarker -> (string)
IfIsTruncated
istrue
,HostedZoneIdMarker
is the ID of the hosted zone of the first traffic policy instance that Route 53 will return if you submit anotherListTrafficPolicyInstances
request.
TrafficPolicyInstanceNameMarker -> (string)
IfIsTruncated
istrue
,TrafficPolicyInstanceNameMarker
is the name of the first traffic policy instance that Route 53 will return if you submit anotherListTrafficPolicyInstances
request.
TrafficPolicyInstanceTypeMarker -> (string)
IfIsTruncated
istrue
,TrafficPolicyInstanceTypeMarker
is the DNS type of the resource record sets that are associated with the first traffic policy instance that Amazon Route 53 will return if you submit anotherListTrafficPolicyInstances
request.
IsTruncated -> (boolean)
A flag that indicates whether there are more traffic policy instances to be listed. If the response was truncated, you can get more traffic policy instances by callingListTrafficPolicyInstances
again and specifying the values of theHostedZoneIdMarker
,TrafficPolicyInstanceNameMarker
, andTrafficPolicyInstanceTypeMarker
in the corresponding request parameters.
MaxItems -> (string)
The value that you specified for theMaxItems
parameter in the call toListTrafficPolicyInstances
that produced the current response.