get-segment¶
Description¶
Returns information about the specified segment. Specify the segment you want to view by specifying its ARN.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
get-segment
--segment <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--segment (string)
The ARN of the segment to return information for.
--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.
See ‘aws help’ for descriptions of global parameters.
Output¶
segment -> (structure)
A structure that contains the complete information about the segment.
arn -> (string)
The ARN of the segment.
createdTime -> (timestamp)
The date and time that this segment was created.
description -> (string)
The customer-created description for this segment.
experimentCount -> (long)
The number of experiments that this segment is used in. This count includes all current experiments, not just those that are currently running.
lastUpdatedTime -> (timestamp)
The date and time that this segment was most recently updated.
launchCount -> (long)
The number of launches that this segment is used in. This count includes all current launches, not just those that are currently running.
name -> (string)
The name of the segment.
pattern -> (string)
tags -> (map)
The list of tag keys and values associated with this launch.
key -> (string)
value -> (string)