Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . devops-agent ]

register-service

Description

This operation registers the specified service

See also: AWS API Documentation

Synopsis

  register-service
--service <value>
--service-details <value>
[--kms-key-arn <value>]
[--private-connection-name <value>]
[--name <value>]
[--tags <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>]
[--v2-debug]

Options

--service (string)

Services that can be registered via the post-registration API (excludes OAuth 3LO services).

Possible values:

• dynatrace
• servicenow
• pagerduty
• gitlab
• eventChannel
• mcpservernewrelic
• mcpservergrafana
• mcpserverdatadog
• mcpserver
• mcpserversplunk
• azureidentity

--service-details (tagged union structure)

Service-specific authorization configuration parameters

Note

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

dynatrace -> (structure)

Dynatrace-specific service details.

accountUrn -> (string)

Dynatrace resource account urn.

authorizationConfig -> (tagged union structure)

Dynatrace OAuth client credentials configuration. Use this when registering with OAuth client credentials flow.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: oAuthClientCredentials.

oAuthClientCredentials -> (structure)

OAuth client credentials configuration.

clientName -> (string)

User friendly OAuth client name specified by end user.

clientId -> (string)

OAuth client ID for authenticating with the service.

exchangeParameters -> (map)

OAuth token exchange parameters for authenticating with the service.

key -> (string)

value -> (string)

Exchange Parameter value for MCP authentication

clientSecret -> (string)

OAuth client secret for authenticating with the service.

servicenow -> (structure)

ServiceNow-specific service details.

instanceUrl -> (string)

ServiceNow instance URL.

authorizationConfig -> (tagged union structure)

ServiceNow OAuth client credentials configuration. Use this when registering with OAuth client credentials flow.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: oAuthClientCredentials.

oAuthClientCredentials -> (structure)

OAuth client credentials configuration.

clientName -> (string)

User friendly OAuth client name specified by end user.

clientId -> (string)

OAuth client ID for authenticating with the service.

exchangeParameters -> (map)

OAuth token exchange parameters for authenticating with the service.

key -> (string)

value -> (string)

Exchange Parameter value for MCP authentication

clientSecret -> (string)

OAuth client secret for authenticating with the service.

mcpserverdatadog -> (structure)

Datadog MCP server-specific service details.

name -> (string)

MCP server name.

endpoint -> (string)

MCP server endpoint URL.

description -> (string)

Optional description for the MCP server.

authorizationConfig -> (tagged union structure)

Datadog MCP server authorization configuration (only authorization discovery is supported).

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: authorizationDiscovery.

authorizationDiscovery -> (structure)

Datadog MCP server authorization discovery configuration.

returnToEndpoint -> (string)

The endpoint to return to after OAuth flow completes (must be AWS console domain)

mcpserver -> (structure)

MCP server-specific service details.

name -> (string)

MCP server name.

endpoint -> (string)

MCP server endpoint URL.

description -> (string)

Optional description for the MCP server.

authorizationConfig -> (tagged union structure)

MCP server authorization configuration.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: oAuthClientCredentials, oAuth3LO, apiKey, bearerToken, authorizationDiscovery.

oAuthClientCredentials -> (structure)

MCP server configuration with OAuth client credentials.

clientName -> (string)

User friendly OAuth client name specified by end user.

clientId -> (string)

OAuth client ID for authenticating with the service.

exchangeParameters -> (map)

OAuth token exchange parameters for authenticating with the service.

key -> (string)

value -> (string)

Exchange Parameter value for MCP authentication

clientSecret -> (string)

OAuth client secret for authenticating with the service.

exchangeUrl -> (string)

OAuth token exchange URL.

scopes -> (list)

OAuth scopes for 3LO authentication. The service will always request scope offline_access.

(string)

oAuth3LO -> (structure)

MCP server configuration with OAuth 3LO.

clientName -> (string)

User friendly OAuth client name specified by end user.

clientId -> (string)

OAuth client ID for authenticating with the service.

exchangeParameters -> (map)

OAuth token exchange parameters for authenticating with the service.

key -> (string)

value -> (string)

Exchange Parameter value for MCP authentication

returnToEndpoint -> (string)

The endpoint to return to after OAuth flow completes (must be AWS console domain)

authorizationUrl -> (string)

OAuth authorization URL for 3LO authentication.

exchangeUrl -> (string)

OAuth token exchange URL.

clientSecret -> (string)

OAuth client secret for authenticating with the service. Required for confidential clients or when PKCE is not supported. Optional for public clients using PKCE.

supportCodeChallenge -> (boolean)

Whether the service supports PKCE (Proof Key for Code Exchange) for enhanced security during the OAuth flow.

scopes -> (list)

OAuth scopes for 3LO authentication. The service will always request scope offline_access.

(string)

apiKey -> (structure)

MCP server configuration with API key authentication.

apiKeyName -> (string)

User friendly API key name specified by end user.

apiKeyValue -> (string)

API key value for authenticating with the service.

apiKeyHeader -> (string)

HTTP header name to send the API key in requests to the service.

bearerToken -> (structure)

MCP server configuration with Bearer token (RFC 6750).

tokenName -> (string)

User friendly bearer token name specified by end user.

tokenValue -> (string)

Bearer token value in alphanumeric for authenticating with the service.

authorizationHeader -> (string)

HTTP header name to send the bearer token in requests to the service. Defaults to ‘Authorization’ per RFC 6750.

authorizationDiscovery -> (structure)

MCP server authorization discovery configuration.

returnToEndpoint -> (string)

The endpoint to return to after OAuth flow completes (must be AWS console domain)

gitlab -> (structure)

GitLab-specific service details.

targetUrl -> (string)

GitLab instance URL (e.g., https://gitlab.com or self-hosted instance).

tokenType -> (string)

Type of GitLab access token

tokenValue -> (string)

GitLab access token value

groupId -> (string)

Optional GitLab group ID for group-level access tokens

mcpserversplunk -> (structure)

Splunk MCP server-specific service details.

name -> (string)

MCP server name.

endpoint -> (string)

MCP server endpoint URL.

description -> (string)

Optional description for the MCP server.

authorizationConfig -> (tagged union structure)

MCP server authorization configuration.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: oAuthClientCredentials, oAuth3LO, apiKey, bearerToken, authorizationDiscovery.

oAuthClientCredentials -> (structure)

MCP server configuration with OAuth client credentials.

clientName -> (string)

User friendly OAuth client name specified by end user.

clientId -> (string)

OAuth client ID for authenticating with the service.

exchangeParameters -> (map)

OAuth token exchange parameters for authenticating with the service.

key -> (string)

value -> (string)

Exchange Parameter value for MCP authentication

clientSecret -> (string)

OAuth client secret for authenticating with the service.

exchangeUrl -> (string)

OAuth token exchange URL.

scopes -> (list)

OAuth scopes for 3LO authentication. The service will always request scope offline_access.

(string)

oAuth3LO -> (structure)

MCP server configuration with OAuth 3LO.

clientName -> (string)

User friendly OAuth client name specified by end user.

clientId -> (string)

OAuth client ID for authenticating with the service.

exchangeParameters -> (map)

OAuth token exchange parameters for authenticating with the service.

key -> (string)

value -> (string)

Exchange Parameter value for MCP authentication

returnToEndpoint -> (string)

The endpoint to return to after OAuth flow completes (must be AWS console domain)

authorizationUrl -> (string)

OAuth authorization URL for 3LO authentication.

exchangeUrl -> (string)

OAuth token exchange URL.

clientSecret -> (string)

OAuth client secret for authenticating with the service. Required for confidential clients or when PKCE is not supported. Optional for public clients using PKCE.

supportCodeChallenge -> (boolean)

Whether the service supports PKCE (Proof Key for Code Exchange) for enhanced security during the OAuth flow.

scopes -> (list)

OAuth scopes for 3LO authentication. The service will always request scope offline_access.

(string)

apiKey -> (structure)

MCP server configuration with API key authentication.

apiKeyName -> (string)

User friendly API key name specified by end user.

apiKeyValue -> (string)

API key value for authenticating with the service.

apiKeyHeader -> (string)

HTTP header name to send the API key in requests to the service.

bearerToken -> (structure)

MCP server configuration with Bearer token (RFC 6750).

tokenName -> (string)

User friendly bearer token name specified by end user.

tokenValue -> (string)

Bearer token value in alphanumeric for authenticating with the service.

authorizationHeader -> (string)

HTTP header name to send the bearer token in requests to the service. Defaults to ‘Authorization’ per RFC 6750.

authorizationDiscovery -> (structure)

MCP server authorization discovery configuration.

returnToEndpoint -> (string)

The endpoint to return to after OAuth flow completes (must be AWS console domain)

mcpservernewrelic -> (structure)

New Relic-specific service details.

authorizationConfig -> (tagged union structure)

New Relic MCP server authorization configuration.

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: apiKey.

apiKey -> (structure)

New Relic API Key authentication (apiKey, accountId, region).

apiKey -> (string)

New Relic User API Key

accountId -> (string)

New Relic Account ID

region -> (string)

New Relic region (US or EU)

applicationIds -> (list)

List of monitored APM application IDs in New Relic

(string)

entityGuids -> (list)

List of globally unique IDs for New Relic resources (apps, hosts, services)

(string)

alertPolicyIds -> (list)

List of alert policy IDs grouping related conditions

(string)

eventChannel -> (structure)

Event Channel specific service details.

type -> (string)

The type of event channel

mcpservergrafana -> (structure)

Datadog MCP server-specific service details.

name -> (string)

MCP server name.

endpoint -> (string)

MCP server endpoint URL.

description -> (string)

Optional description for the MCP server.

authorizationConfig -> (tagged union structure)

Grafana MCP server authorization configuration (experimental).

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: oAuthClientCredentials, oAuth3LO, apiKey, bearerToken, authorizationDiscovery.

oAuthClientCredentials -> (structure)

MCP server configuration with OAuth client credentials.

clientName -> (string)

User friendly OAuth client name specified by end user.

clientId -> (string)

OAuth client ID for authenticating with the service.

exchangeParameters -> (map)

OAuth token exchange parameters for authenticating with the service.

key -> (string)

value -> (string)

Exchange Parameter value for MCP authentication

clientSecret -> (string)

OAuth client secret for authenticating with the service.

exchangeUrl -> (string)

OAuth token exchange URL.

scopes -> (list)

OAuth scopes for 3LO authentication. The service will always request scope offline_access.

(string)

oAuth3LO -> (structure)

MCP server configuration with OAuth 3LO.

clientName -> (string)

User friendly OAuth client name specified by end user.

clientId -> (string)

OAuth client ID for authenticating with the service.

exchangeParameters -> (map)

OAuth token exchange parameters for authenticating with the service.

key -> (string)

value -> (string)

Exchange Parameter value for MCP authentication

returnToEndpoint -> (string)

The endpoint to return to after OAuth flow completes (must be AWS console domain)

authorizationUrl -> (string)

OAuth authorization URL for 3LO authentication.

exchangeUrl -> (string)

OAuth token exchange URL.

clientSecret -> (string)

OAuth client secret for authenticating with the service. Required for confidential clients or when PKCE is not supported. Optional for public clients using PKCE.

supportCodeChallenge -> (boolean)

Whether the service supports PKCE (Proof Key for Code Exchange) for enhanced security during the OAuth flow.

scopes -> (list)

OAuth scopes for 3LO authentication. The service will always request scope offline_access.

(string)

apiKey -> (structure)

MCP server configuration with API key authentication.

apiKeyName -> (string)

User friendly API key name specified by end user.

apiKeyValue -> (string)

API key value for authenticating with the service.

apiKeyHeader -> (string)

HTTP header name to send the API key in requests to the service.

bearerToken -> (structure)

MCP server configuration with Bearer token (RFC 6750).

tokenName -> (string)

User friendly bearer token name specified by end user.

tokenValue -> (string)

Bearer token value in alphanumeric for authenticating with the service.

authorizationHeader -> (string)

HTTP header name to send the bearer token in requests to the service. Defaults to ‘Authorization’ per RFC 6750.

authorizationDiscovery -> (structure)

MCP server authorization discovery configuration.

returnToEndpoint -> (string)

The endpoint to return to after OAuth flow completes (must be AWS console domain)

pagerduty -> (structure)

PagerDuty specific service details.

scopes -> (list)

PagerDuty scopes.

(string)

authorizationConfig -> (tagged union structure)

PagerDuty authorization configuration

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: oAuthClientCredentials.

oAuthClientCredentials -> (structure)

OAuth client credentials configuration.

clientName -> (string)

User friendly OAuth client name specified by end user.

clientId -> (string)

OAuth client ID for authenticating with the service.

exchangeParameters -> (map)

OAuth token exchange parameters for authenticating with the service.

key -> (string)

value -> (string)

Exchange Parameter value for MCP authentication

clientSecret -> (string)

OAuth client secret for authenticating with the service.

azureidentity -> (structure)

Azure integration with AWS Outbound Identity Federation specific service details.

tenantId -> (string)

The Azure Active Directory tenant ID for the identity.

clientId -> (string)

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

webIdentityRoleArn -> (string)

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

webIdentityTokenAudiences -> (list)

The audiences for the Web Identity Token.

(string)

JSON Syntax:

{
  "dynatrace": {
    "accountUrn": "string",
    "authorizationConfig": {
      "oAuthClientCredentials": {
        "clientName": "string",
        "clientId": "string",
        "exchangeParameters": {"string": "string"
          ...},
        "clientSecret": "string"
      }
    }
  },
  "servicenow": {
    "instanceUrl": "string",
    "authorizationConfig": {
      "oAuthClientCredentials": {
        "clientName": "string",
        "clientId": "string",
        "exchangeParameters": {"string": "string"
          ...},
        "clientSecret": "string"
      }
    }
  },
  "mcpserverdatadog": {
    "name": "string",
    "endpoint": "string",
    "description": "string",
    "authorizationConfig": {
      "authorizationDiscovery": {
        "returnToEndpoint": "string"
      }
    }
  },
  "mcpserver": {
    "name": "string",
    "endpoint": "string",
    "description": "string",
    "authorizationConfig": {
      "oAuthClientCredentials": {
        "clientName": "string",
        "clientId": "string",
        "exchangeParameters": {"string": "string"
          ...},
        "clientSecret": "string",
        "exchangeUrl": "string",
        "scopes": ["string", ...]
      },
      "oAuth3LO": {
        "clientName": "string",
        "clientId": "string",
        "exchangeParameters": {"string": "string"
          ...},
        "returnToEndpoint": "string",
        "authorizationUrl": "string",
        "exchangeUrl": "string",
        "clientSecret": "string",
        "supportCodeChallenge": true|false,
        "scopes": ["string", ...]
      },
      "apiKey": {
        "apiKeyName": "string",
        "apiKeyValue": "string",
        "apiKeyHeader": "string"
      },
      "bearerToken": {
        "tokenName": "string",
        "tokenValue": "string",
        "authorizationHeader": "string"
      },
      "authorizationDiscovery": {
        "returnToEndpoint": "string"
      }
    }
  },
  "gitlab": {
    "targetUrl": "string",
    "tokenType": "personal"|"group",
    "tokenValue": "string",
    "groupId": "string"
  },
  "mcpserversplunk": {
    "name": "string",
    "endpoint": "string",
    "description": "string",
    "authorizationConfig": {
      "oAuthClientCredentials": {
        "clientName": "string",
        "clientId": "string",
        "exchangeParameters": {"string": "string"
          ...},
        "clientSecret": "string",
        "exchangeUrl": "string",
        "scopes": ["string", ...]
      },
      "oAuth3LO": {
        "clientName": "string",
        "clientId": "string",
        "exchangeParameters": {"string": "string"
          ...},
        "returnToEndpoint": "string",
        "authorizationUrl": "string",
        "exchangeUrl": "string",
        "clientSecret": "string",
        "supportCodeChallenge": true|false,
        "scopes": ["string", ...]
      },
      "apiKey": {
        "apiKeyName": "string",
        "apiKeyValue": "string",
        "apiKeyHeader": "string"
      },
      "bearerToken": {
        "tokenName": "string",
        "tokenValue": "string",
        "authorizationHeader": "string"
      },
      "authorizationDiscovery": {
        "returnToEndpoint": "string"
      }
    }
  },
  "mcpservernewrelic": {
    "authorizationConfig": {
      "apiKey": {
        "apiKey": "string",
        "accountId": "string",
        "region": "US"|"EU",
        "applicationIds": ["string", ...],
        "entityGuids": ["string", ...],
        "alertPolicyIds": ["string", ...]
      }
    }
  },
  "eventChannel": {
    "type": "webhook"
  },
  "mcpservergrafana": {
    "name": "string",
    "endpoint": "string",
    "description": "string",
    "authorizationConfig": {
      "oAuthClientCredentials": {
        "clientName": "string",
        "clientId": "string",
        "exchangeParameters": {"string": "string"
          ...},
        "clientSecret": "string",
        "exchangeUrl": "string",
        "scopes": ["string", ...]
      },
      "oAuth3LO": {
        "clientName": "string",
        "clientId": "string",
        "exchangeParameters": {"string": "string"
          ...},
        "returnToEndpoint": "string",
        "authorizationUrl": "string",
        "exchangeUrl": "string",
        "clientSecret": "string",
        "supportCodeChallenge": true|false,
        "scopes": ["string", ...]
      },
      "apiKey": {
        "apiKeyName": "string",
        "apiKeyValue": "string",
        "apiKeyHeader": "string"
      },
      "bearerToken": {
        "tokenName": "string",
        "tokenValue": "string",
        "authorizationHeader": "string"
      },
      "authorizationDiscovery": {
        "returnToEndpoint": "string"
      }
    }
  },
  "pagerduty": {
    "scopes": ["string", ...],
    "authorizationConfig": {
      "oAuthClientCredentials": {
        "clientName": "string",
        "clientId": "string",
        "exchangeParameters": {"string": "string"
          ...},
        "clientSecret": "string"
      }
    }
  },
  "azureidentity": {
    "tenantId": "string",
    "clientId": "string",
    "webIdentityRoleArn": "string",
    "webIdentityTokenAudiences": ["string", ...]
  }
}

--kms-key-arn (string)

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

--private-connection-name (string)

The name of the private connection to use for VPC connectivity.

--name (string)

The display name for the service registration.

--tags (map)

Tags to add to the Service at registration time.

key -> (string)

Tag key string.

value -> (string)

Tag value string.

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

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

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

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

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

serviceId -> (string)

Service ID - present when registration is complete, absent when additional steps are required

additionalStep -> (tagged union structure)

Indicates if additional steps are required to complete service registration (e.g., 3-legged OAuth)

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: oauth.

oauth -> (structure)

OAuth authorization step required.

authorizationUrl -> (string)

The URL to redirect the user to for OAuth authorization.

kmsKeyArn -> (string)

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

tags -> (map)

Tags associated with the registered Service.

key -> (string)

Tag key string.

value -> (string)

Tag value string.