get-service¶

Description¶

Retrieves given service by it’s unique identifier

Synopsis¶

  get-service
--service-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>]

Options¶

--service-id (string) [required]

The unique identifier of the given service.

Constraints:

min: 1

max: 255

pattern: [a-zA-Z0-9_-]+

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

service -> (structure)

Represents a registered service with its configuration and accessible resources.

serviceId -> (string) [required]

The unique identifier of a service.

Constraints:

min: 1

max: 255

pattern: [a-zA-Z0-9_-]+

serviceType -> (string) [required]

The service type e.g github or dynatrace

Possible values:

github

slack

azure

azuredevops

dynatrace

servicenow

pagerduty

gitlab

eventChannel

mcpservernewrelic

mcpservergrafana

mcpserverdatadog

mcpserver

mcpserversplunk

azureidentity

name -> (string)

The display name of the registered service.

Constraints:

min: 1

max: 255

pattern: [\p{L}\p{N}\p{P}\p{S}\p{Z}]+

accessibleResources -> (list)

List of accessible resources for this service.

(document)

additionalServiceDetails -> (tagged union structure)

Additional details specific to the service type.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: github, slack, mcpserverdatadog, mcpserver, servicenow, gitlab, mcpserversplunk, mcpservernewrelic, azuredevops, azureidentity, mcpservergrafana, pagerduty.

github -> (structure)

GitHub-specific service details.

owner -> (string) [required]

The GitHub repository owner name.

ownerType -> (string) [required]

The GitHub repository owner type.

Possible values:

organization

user

targetUrl -> (string)

The GitHub Enterprise Server instance URL (absent for github.com).

slack -> (structure)

Slack-specific service details.

teamId -> (string) [required]

The Slack team ID.

teamName -> (string) [required]

The Slack team name.

mcpserverdatadog -> (structure)

Datadog MCP server-specific service details.

name -> (string) [required]

The MCP server name.

endpoint -> (string) [required]

The MCP server endpoint URL.

authorizationMethod -> (string) [required]

The MCP server uses this authorization method.

Possible values:

oauth-client-credentials

oauth-3lo

api-key

bearer-token

description -> (string)

Optional description for the MCP server.

Constraints:

min: 1

max: 1000

pattern: [\p{L}\p{N}\p{P}\p{S}\p{Z}]+

apiKeyHeader -> (string)

If the MCP server uses API key authentication, these details are provided.

mcpserver -> (structure)

MCP server-specific service details.

name -> (string) [required]

The MCP server name.

endpoint -> (string) [required]

The MCP server endpoint URL.

authorizationMethod -> (string) [required]

The MCP server uses this authorization method.

Possible values:

oauth-client-credentials

oauth-3lo

api-key

bearer-token

description -> (string)

Optional description for the MCP server.

Constraints:

min: 1

max: 1000

pattern: [\p{L}\p{N}\p{P}\p{S}\p{Z}]+

apiKeyHeader -> (string)

If the MCP server uses API key authentication, these details are provided.

servicenow -> (structure)

ServiceNow-specific service details.

instanceUrl -> (string)

The ServiceNow instance url

Constraints:

min: 1

max: 255

pattern: https://[a-zA-Z0-9]([a-zA-Z0-9.-]*[a-zA-Z0-9])\.service-now\.com/?

gitlab -> (structure)

GitLab-specific service details.

targetUrl -> (string) [required]

The GitLab instance URL.

tokenType -> (string) [required]

Type of GitLab access token

Possible values:

personal

group

groupId -> (string)

Optional GitLab group ID for group-level access tokens

mcpserversplunk -> (structure)

Splunk MCP server-specific service details.

name -> (string) [required]

The MCP server name.

endpoint -> (string) [required]

The MCP server endpoint URL.

authorizationMethod -> (string) [required]

The MCP server uses this authorization method.

Possible values:

oauth-client-credentials

oauth-3lo

api-key

bearer-token

description -> (string)

Optional description for the MCP server.

Constraints:

min: 1

max: 1000

pattern: [\p{L}\p{N}\p{P}\p{S}\p{Z}]+

apiKeyHeader -> (string)

If the MCP server uses API key authentication, these details are provided.

mcpservernewrelic -> (structure)

New Relic MCP server-specific service details.

accountId -> (string) [required]

The NewRelic account ID.

region -> (string) [required]

The NewRelic region (determines API endpoint).

Possible values:

US

EU

description -> (string)

Optional user description.

Constraints:

min: 1

max: 1000

pattern: [\p{L}\p{N}\p{P}\p{S}\p{Z}]+

azuredevops -> (structure)

Azure DevOps specific service details.

organizationName -> (string) [required]

The Azure DevOps Organization name associated with the service.

azureidentity -> (structure)

Azure identity details for services using Azure authentication.

tenantId -> (string) [required]

The Azure Active Directory tenant ID for the identity.

Constraints:

min: 0

max: 36

pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

clientId -> (string) [required]

The client ID of the service principal or managed identity used for authentication.

Constraints:

min: 0

max: 36

pattern: [0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}

webIdentityRoleArn -> (string) [required]

The role ARN to be assumed by DevOps Agent for requesting Web Identity Token.

Constraints:

min: 1

max: 255

pattern: arn:aws:iam::\d{12}:role/[a-zA-Z0-9+=,.@_/-]+

webIdentityTokenAudiences -> (list) [required]

The audiences for the Web Identity Token.

(string)

mcpservergrafana -> (structure)

Grafana MCP server-specific service details.

endpoint -> (string) [required]

Grafana instance URL (e.g., https://your-instance.grafana.net)

Constraints:

pattern: https://[a-zA-Z0-9.-]+(?::[0-9]+)?(?:/.*)?

authorizationMethod -> (string) [required]

The authz method used by the MCP server.

Possible values:

oauth-client-credentials

oauth-3lo

api-key

bearer-token

pagerduty -> (structure)

Pagerduty service details.

scopes -> (list) [required]

The scopes that were assigned to the service

(string)

kmsKeyArn -> (string)

The ARN of the AWS Key Management Service (AWS KMS) customer managed key that’s used to encrypt resources.

Constraints:

min: 20

pattern: arn:aws[a-zA-Z-]*:kms:[a-z0-9-]+:[0-9]{12}:key/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

privateConnectionName -> (string)

The name of the private connection used for VPC connectivity.

Constraints:

min: 3

max: 30

pattern: [a-z0-9]([a-z0-9-]*[a-z0-9])?

tags -> (map)

Tags associated with the Service.

key -> (string)

Tag key string.

Constraints:

min: 1

max: 128

pattern: [\p{L}\p{Z}\p{N}_.:/=+\-@]*

value -> (string)

Tag value string.

Constraints:

min: 0

max: 256

pattern: [\p{L}\p{Z}\p{N}_.:/=+\-@]*

Table of Contents

Feedback

User Guide

get-service¶

Description¶

Synopsis¶

Options¶

Global Options¶

Output¶

Note