AWS CLI Command Reference

[ aws . application-signals ]

get-service

Description

Returns information about a service discovered by Application Signals.

See also: AWS API Documentation

Synopsis

  get-service
--start-time <value>
--end-time <value>
--key-attributes <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]

Options

--start-time (timestamp)

The start of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

--end-time (timestamp)

The end of the time period to retrieve information about. When used in a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057

--key-attributes (map)

Use this field to specify which service you want to retrieve information for. You must specify at least the Type , Name , and Environment attributes.

This is a string-to-string map. It can include the following fields.

  • Type designates the type of object this is.
  • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource .
  • Name specifies the name of the object. This is used only if the value of the Type field is Service , RemoteService , or AWS::Service .
  • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource .
  • Environment specifies the location where this object is hosted, or what it belongs to.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "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.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--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.

Output

Service -> (structure)

A structure containing information about the service.

KeyAttributes -> (map)

This is a string-to-string map. It can include the following fields.

  • Type designates the type of object this is.
  • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource .
  • Name specifies the name of the object. This is used only if the value of the Type field is Service , RemoteService , or AWS::Service .
  • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource .
  • Environment specifies the location where this object is hosted, or what it belongs to.

key -> (string)

value -> (string)

AttributeMaps -> (list)

This structure contains one or more string-to-string maps that help identify this service. It can include platform attributes , application attributes , and telemetry attributes .

Platform attributes contain information the service’s platform.

  • PlatformType defines the hosted-in platform.
  • EKS.Cluster is the name of the Amazon EKS cluster.
  • K8s.Cluster is the name of the self-hosted Kubernetes cluster.
  • K8s.Namespace is the name of the Kubernetes namespace in either Amazon EKS or Kubernetes clusters.
  • K8s.Workload is the name of the Kubernetes workload in either Amazon EKS or Kubernetes clusters.
  • K8s.Node is the name of the Kubernetes node in either Amazon EKS or Kubernetes clusters.
  • K8s.Pod is the name of the Kubernetes pod in either Amazon EKS or Kubernetes clusters.
  • EC2.AutoScalingGroup is the name of the Amazon EC2 Auto Scaling group.
  • EC2.InstanceId is the ID of the Amazon EC2 instance.
  • Host is the name of the host, for all platform types.

Applciation attributes contain information about the application.

  • AWS.Application is the application’s name in Amazon Web Services Service Catalog AppRegistry.
  • AWS.Application.ARN is the application’s ARN in Amazon Web Services Service Catalog AppRegistry.

Telemetry attributes contain telemetry information.

  • Telemetry.SDK is the fingerprint of the OpenTelemetry SDK version for instrumented services.
  • Telemetry.Agent is the fingerprint of the agent used to collect and send telemetry data.
  • Telemetry.Source Specifies the point of application where the telemetry was collected or specifies what was used for the source of telemetry data.

(map)

key -> (string)

value -> (string)

MetricReferences -> (list)

An array of structures that each contain information about one metric associated with this service.

(structure)

This structure contains information about one CloudWatch metric associated with this entity discovered by Application Signals.

Namespace -> (string)

The namespace of the metric. For more information, see CloudWatchNamespaces .

MetricType -> (string)

Used to display the appropriate statistics in the CloudWatch console.

Dimensions -> (list)

An array of one or more dimensions that further define the metric. For more information, see CloudWatchDimensions .

(structure)

A dimension is a name/value pair that is part of the identity of a metric. Because dimensions are part of the unique identifier for a metric, whenever you add a unique name/value pair to one of your metrics, you are creating a new variation of that metric. For example, many Amazon EC2 metrics publish InstanceId as a dimension name, and the actual instance ID as the value for that dimension.

You can assign up to 30 dimensions to a metric.

Name -> (string)

The name of the dimension. Dimension names must contain only ASCII characters, must include at least one non-whitespace character, and cannot start with a colon (: ). ASCII control characters are not supported as part of dimension names.

Value -> (string)

The value of the dimension. Dimension values must contain only ASCII characters and must include at least one non-whitespace character. ASCII control characters are not supported as part of dimension values.

MetricName -> (string)

The name of the metric.

StartTime -> (timestamp)

The start time of the data included in the response. In a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057 .

EndTime -> (timestamp)

The end time of the data included in the response. In a raw HTTP Query API, it is formatted as be epoch time in seconds. For example: 1698778057 .
© Copyright 2018, Amazon Web Services. Created using Sphinx.