2026/10/12 - AWS DevOps Agent Service - 6 updated api methods
Changes Adds support for the includedData field in GetAgentSpace and ListAgentSpaces APIs
{'monthlyAccountGraderHours': {'limit': 'integer', 'usage': 'double'}}
Retrieves monthly account usage metrics and limits for the AWS account.
See also: AWS API Documentation
Request Syntax
client.get_account_usage()
dict
Response Syntax
{
'monthlyAccountInvestigationHours': {
'limit': 123,
'usage': 123.0
},
'monthlyAccountEvaluationHours': {
'limit': 123,
'usage': 123.0
},
'monthlyAccountSystemLearningHours': {
'limit': 123,
'usage': 123.0
},
'monthlyAccountOnDemandHours': {
'limit': 123,
'usage': 123.0
},
'monthlyAccountGraderHours': {
'limit': 123,
'usage': 123.0
},
'usagePeriodStartTime': datetime(2015, 1, 1),
'usagePeriodEndTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
monthlyAccountInvestigationHours (dict) --
Monthly investigation hours usage and limit for an account
limit (integer) --
Configured limit for this metric. A value of -1 indicates no limit is enforced.
usage (float) --
Current usage for this metric
monthlyAccountEvaluationHours (dict) --
Monthly evaluation hours usage and limit for an account
limit (integer) --
Configured limit for this metric. A value of -1 indicates no limit is enforced.
usage (float) --
Current usage for this metric
monthlyAccountSystemLearningHours (dict) --
Monthly system learning hours usage and limit for an account
limit (integer) --
Configured limit for this metric. A value of -1 indicates no limit is enforced.
usage (float) --
Current usage for this metric
monthlyAccountOnDemandHours (dict) --
Monthly on-demand hours usage and limit for an account
limit (integer) --
Configured limit for this metric. A value of -1 indicates no limit is enforced.
usage (float) --
Current usage for this metric
monthlyAccountGraderHours (dict) --
Represents a usage metric with its configured limit and current usage value.
limit (integer) --
Configured limit for this metric. A value of -1 indicates no limit is enforced.
usage (float) --
Current usage for this metric
usagePeriodStartTime (datetime) --
The start time of the usage tracking period
usagePeriodEndTime (datetime) --
The end time of the usage tracking period
{'includedData': 'METADATA_ONLY | ALL_DATA'}
Retrieves detailed information about a specific AgentSpace.
See also: AWS API Documentation
Request Syntax
client.get_agent_space(
agentSpaceId='string',
includedData='METADATA_ONLY'|'ALL_DATA'
)
string
[REQUIRED]
The unique identifier of the AgentSpace
string
How much data to include in the response.
dict
Response Syntax
{
'agentSpace': {
'name': 'string',
'description': 'string',
'locale': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'kmsKeyArn': 'string',
'agentSpaceId': 'string',
'preferences': {
'string': True|False
}
},
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Output containing the requested AgentSpace details.
agentSpace (dict) --
Represents a complete AgentSpace with all its properties, timestamps, encryption settings, and unique identifier.
name (string) --
The name of the AgentSpace.
description (string) --
The description of the AgentSpace.
locale (string) --
The locale for the AgentSpace, which determines the language used in agent responses.
createdAt (datetime) --
The timestamp when the resource was created.
updatedAt (datetime) --
The timestamp when the resource was last updated.
kmsKeyArn (string) --
The ARN of the AWS Key Management Service (AWS KMS) customer managed key that's used to encrypt resources.
agentSpaceId (string) --
The unique identifier of the AgentSpace
preferences (dict) --
The preferences configured on the agent space. Preferences that are not set take their default values.
(string) --
The key of a preference that can be configured on an agent space. The elevatedActionsEnabled key controls whether elevated directed actions are permitted in the agent space. Elevated directed actions are mutating operations that also require per-action operator approval, and default to false when not set.
(boolean) --
tags (dict) --
Tags associated with the AgentSpace.
(string) --
Tag key string.
(string) --
Tag value string.
{'service': {'additionalServiceDetails': {'mcpserver': {'authorizationMethod': {'custom-headers'},
'customHeaderNames': ['string']},
'mcpserverdatadog': {'authorizationMethod': {'custom-headers'},
'customHeaderNames': ['string']},
'mcpservergrafana': {'authorizationMethod': {'custom-headers'}},
'mcpserversplunk': {'authorizationMethod': {'custom-headers'},
'customHeaderNames': ['string']}}}}
Retrieves given service by it's unique identifier
See also: AWS API Documentation
Request Syntax
client.get_service(
serviceId='string'
)
string
[REQUIRED]
The unique identifier of the given service.
dict
Response Syntax
{
'service': {
'serviceId': 'string',
'serviceType': 'github'|'slack'|'azure'|'azuredevops'|'dynatrace'|'servicenow'|'pagerduty'|'gitlab'|'eventChannel'|'mcpservernewrelic'|'mcpservergrafana'|'mcpserverdatadog'|'mcpserver'|'mcpserversplunk'|'azureidentity'|'mcpserversigv4'|'remoteagent'|'remoteagentsigv4',
'name': 'string',
'accessibleResources': [
{...}|[...]|123|123.4|'string'|True|None,
],
'additionalServiceDetails': {
'github': {
'owner': 'string',
'ownerType': 'organization'|'user',
'targetUrl': 'string'
},
'slack': {
'teamId': 'string',
'teamName': 'string'
},
'mcpserverdatadog': {
'name': 'string',
'endpoint': 'string',
'authorizationMethod': 'oauth-client-credentials'|'oauth-3lo'|'api-key'|'bearer-token'|'custom-headers',
'description': 'string',
'apiKeyHeader': 'string',
'customHeaderNames': [
'string',
]
},
'mcpserver': {
'name': 'string',
'endpoint': 'string',
'authorizationMethod': 'oauth-client-credentials'|'oauth-3lo'|'api-key'|'bearer-token'|'custom-headers',
'description': 'string',
'apiKeyHeader': 'string',
'customHeaderNames': [
'string',
]
},
'servicenow': {
'instanceUrl': 'string'
},
'gitlab': {
'targetUrl': 'string',
'tokenType': 'personal'|'group',
'groupId': 'string'
},
'mcpserversplunk': {
'name': 'string',
'endpoint': 'string',
'authorizationMethod': 'oauth-client-credentials'|'oauth-3lo'|'api-key'|'bearer-token'|'custom-headers',
'description': 'string',
'apiKeyHeader': 'string',
'customHeaderNames': [
'string',
]
},
'mcpservernewrelic': {
'accountId': 'string',
'region': 'US'|'EU'|'JP',
'description': 'string'
},
'azuredevops': {
'organizationName': 'string'
},
'azureidentity': {
'tenantId': 'string',
'clientId': 'string',
'webIdentityRoleArn': 'string',
'webIdentityTokenAudiences': [
'string',
]
},
'mcpservergrafana': {
'endpoint': 'string',
'authorizationMethod': 'oauth-client-credentials'|'oauth-3lo'|'api-key'|'bearer-token'|'custom-headers'
},
'pagerduty': {
'scopes': [
'string',
]
},
'mcpserversigv4': {
'name': 'string',
'endpoint': 'string',
'description': 'string',
'region': 'string',
'service': 'string',
'roleArn': 'string',
'mcpRoleArn': 'string',
'customHeaders': {
'string': 'string'
}
},
'remoteagent': {
'name': 'string',
'endpoint': 'string',
'description': 'string',
'authorizationMethod': 'oauth-client-credentials'|'api-key'|'bearer-token',
'apiKeyHeader': 'string'
},
'remoteagentsigv4': {
'name': 'string',
'endpoint': 'string',
'description': 'string',
'region': 'string',
'service': 'string',
'roleArn': 'string'
}
},
'kmsKeyArn': 'string',
'privateConnectionName': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Output containing the requested service details.
service (dict) --
Represents a registered service with its configuration and accessible resources.
serviceId (string) --
The unique identifier of a service.
serviceType (string) --
The service type e.g github or dynatrace
name (string) --
The display name of the registered service.
accessibleResources (list) --
List of accessible resources for this service.
(:ref:`document<document>`) --
additionalServiceDetails (dict) --
Additional details specific to the service type.
github (dict) --
GitHub-specific service details.
owner (string) --
The GitHub repository owner name.
ownerType (string) --
The GitHub repository owner type.
targetUrl (string) --
The GitHub Enterprise Server instance URL (absent for github.com).
slack (dict) --
Slack-specific service details.
teamId (string) --
The Slack team ID.
teamName (string) --
The Slack team name.
mcpserverdatadog (dict) --
Datadog MCP server-specific service details.
name (string) --
The MCP server name.
endpoint (string) --
The MCP server endpoint URL.
authorizationMethod (string) --
The MCP server uses this authorization method.
description (string) --
Optional description for the MCP server.
apiKeyHeader (string) --
If the MCP server uses API key authentication, these details are provided.
customHeaderNames (list) --
The configured custom authentication header names when the MCP server uses custom-header authentication. Secret values are not returned.
(string) --
HTTP header name. Allows alphanumeric characters, hyphens, and underscores.
mcpserver (dict) --
MCP server-specific service details.
name (string) --
The MCP server name.
endpoint (string) --
The MCP server endpoint URL.
authorizationMethod (string) --
The MCP server uses this authorization method.
description (string) --
Optional description for the MCP server.
apiKeyHeader (string) --
If the MCP server uses API key authentication, these details are provided.
customHeaderNames (list) --
The configured custom authentication header names when the MCP server uses custom-header authentication. Secret values are not returned.
(string) --
HTTP header name. Allows alphanumeric characters, hyphens, and underscores.
servicenow (dict) --
ServiceNow-specific service details.
instanceUrl (string) --
The ServiceNow instance url
gitlab (dict) --
GitLab-specific service details.
targetUrl (string) --
The GitLab instance URL.
tokenType (string) --
Type of GitLab access token
groupId (string) --
Optional GitLab group ID for group-level access tokens
mcpserversplunk (dict) --
Splunk MCP server-specific service details.
name (string) --
The MCP server name.
endpoint (string) --
The MCP server endpoint URL.
authorizationMethod (string) --
The MCP server uses this authorization method.
description (string) --
Optional description for the MCP server.
apiKeyHeader (string) --
If the MCP server uses API key authentication, these details are provided.
customHeaderNames (list) --
The configured custom authentication header names when the MCP server uses custom-header authentication. Secret values are not returned.
(string) --
HTTP header name. Allows alphanumeric characters, hyphens, and underscores.
mcpservernewrelic (dict) --
New Relic MCP server-specific service details.
accountId (string) --
The NewRelic account ID.
region (string) --
The NewRelic region (determines API endpoint).
description (string) --
Optional user description.
azuredevops (dict) --
Azure DevOps specific service details.
organizationName (string) --
The Azure DevOps Organization name associated with the service.
azureidentity (dict) --
Azure identity details for services using Azure authentication.
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) --
mcpservergrafana (dict) --
Grafana MCP server-specific service details.
endpoint (string) --
Grafana instance URL (e.g., https://your-instance.grafana.net)
authorizationMethod (string) --
The authz method used by the MCP server.
pagerduty (dict) --
Pagerduty service details.
scopes (list) --
The scopes that were assigned to the service
(string) --
mcpserversigv4 (dict) --
SigV4-authenticated MCP server-specific service details.
name (string) --
MCP server name.
endpoint (string) --
MCP server endpoint URL.
description (string) --
Optional description for the MCP server.
region (string) --
AWS region for SigV4 signing. Use '*' for SigV4a multi-region signing.
service (string) --
AWS service name for SigV4 signing.
roleArn (string) --
IAM role ARN to assume for SigV4 signing.
mcpRoleArn (string) --
AWS IAM role ARN.
customHeaders (dict) --
Custom headers for the SigV4 MCP server.
(string) --
HTTP header name. Allows alphanumeric characters, hyphens, and underscores.
(string) --
Value type for custom headers.
remoteagent (dict) --
Remote A2A agent-specific service details (token-based auth).
name (string) --
Name identifier for a remote A2A agent.
endpoint (string) --
HTTPS endpoint URL for a remote A2A agent.
description (string) --
Description field
authorizationMethod (string) --
The authorization method used by the remote agent.
apiKeyHeader (string) --
If the remote agent uses API key authentication, the header name.
remoteagentsigv4 (dict) --
Remote A2A agent-specific service details (SigV4 auth).
name (string) --
Name identifier for a remote A2A agent.
endpoint (string) --
HTTPS endpoint URL for a remote A2A agent.
description (string) --
Description field
region (string) --
AWS region identifier or wildcard (*) for SigV4a multi-region signing.
service (string) --
The AWS service name for SigV4 signing.
roleArn (string) --
AWS IAM role ARN.
kmsKeyArn (string) --
The ARN of the AWS Key Management Service (AWS KMS) customer managed key that's used to encrypt resources.
privateConnectionName (string) --
The name of the private connection used for VPC connectivity.
createdAt (datetime) --
The timestamp when the service was registered.
updatedAt (datetime) --
The timestamp when the service was last updated.
tags (dict) --
Tags associated with the Service.
(string) --
Tag key string.
(string) --
Tag value string.
{'includedData': 'METADATA_ONLY | ALL_DATA'}
Lists all AgentSpaces with optional pagination.
See also: AWS API Documentation
Request Syntax
client.list_agent_spaces(
maxResults=123,
nextToken='string',
includedData='METADATA_ONLY'|'ALL_DATA'
)
integer
Maximum number of results to return in a single call.
string
Token for the next page of results.
string
How much data to include in the response.
dict
Response Syntax
{
'nextToken': 'string',
'agentSpaces': [
{
'name': 'string',
'description': 'string',
'locale': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'kmsKeyArn': 'string',
'agentSpaceId': 'string',
'preferences': {
'string': True|False
}
},
]
}
Response Structure
(dict) --
Output containing a list of AgentSpaces and pagination token.
nextToken (string) --
Token to retrieve the next page of results, if there are more results.
agentSpaces (list) --
The list of AgentSpaces.
(dict) --
Represents a complete AgentSpace with all its properties, timestamps, encryption settings, and unique identifier.
name (string) --
The name of the AgentSpace.
description (string) --
The description of the AgentSpace.
locale (string) --
The locale for the AgentSpace, which determines the language used in agent responses.
createdAt (datetime) --
The timestamp when the resource was created.
updatedAt (datetime) --
The timestamp when the resource was last updated.
kmsKeyArn (string) --
The ARN of the AWS Key Management Service (AWS KMS) customer managed key that's used to encrypt resources.
agentSpaceId (string) --
The unique identifier of the AgentSpace
preferences (dict) --
The preferences configured on the agent space. Preferences that are not set take their default values.
(string) --
The key of a preference that can be configured on an agent space. The elevatedActionsEnabled key controls whether elevated directed actions are permitted in the agent space. Elevated directed actions are mutating operations that also require per-action operator approval, and default to false when not set.
(boolean) --
{'services': {'additionalServiceDetails': {'mcpserver': {'authorizationMethod': {'custom-headers'},
'customHeaderNames': ['string']},
'mcpserverdatadog': {'authorizationMethod': {'custom-headers'},
'customHeaderNames': ['string']},
'mcpservergrafana': {'authorizationMethod': {'custom-headers'}},
'mcpserversplunk': {'authorizationMethod': {'custom-headers'},
'customHeaderNames': ['string']}}}}
List a list of registered service on the account level.
See also: AWS API Documentation
Request Syntax
client.list_services(
maxResults=123,
nextToken='string',
filterServiceType='github'|'slack'|'azure'|'azuredevops'|'dynatrace'|'servicenow'|'pagerduty'|'gitlab'|'eventChannel'|'mcpservernewrelic'|'mcpservergrafana'|'mcpserverdatadog'|'mcpserver'|'mcpserversplunk'|'azureidentity'|'mcpserversigv4'|'remoteagent'|'remoteagentsigv4'
)
integer
Maximum number of results to return in a single call.
string
Token for the next page of results.
string
Optional filter to list only services of a specific type.
dict
Response Syntax
{
'nextToken': 'string',
'services': [
{
'serviceId': 'string',
'serviceType': 'github'|'slack'|'azure'|'azuredevops'|'dynatrace'|'servicenow'|'pagerduty'|'gitlab'|'eventChannel'|'mcpservernewrelic'|'mcpservergrafana'|'mcpserverdatadog'|'mcpserver'|'mcpserversplunk'|'azureidentity'|'mcpserversigv4'|'remoteagent'|'remoteagentsigv4',
'name': 'string',
'accessibleResources': [
{...}|[...]|123|123.4|'string'|True|None,
],
'additionalServiceDetails': {
'github': {
'owner': 'string',
'ownerType': 'organization'|'user',
'targetUrl': 'string'
},
'slack': {
'teamId': 'string',
'teamName': 'string'
},
'mcpserverdatadog': {
'name': 'string',
'endpoint': 'string',
'authorizationMethod': 'oauth-client-credentials'|'oauth-3lo'|'api-key'|'bearer-token'|'custom-headers',
'description': 'string',
'apiKeyHeader': 'string',
'customHeaderNames': [
'string',
]
},
'mcpserver': {
'name': 'string',
'endpoint': 'string',
'authorizationMethod': 'oauth-client-credentials'|'oauth-3lo'|'api-key'|'bearer-token'|'custom-headers',
'description': 'string',
'apiKeyHeader': 'string',
'customHeaderNames': [
'string',
]
},
'servicenow': {
'instanceUrl': 'string'
},
'gitlab': {
'targetUrl': 'string',
'tokenType': 'personal'|'group',
'groupId': 'string'
},
'mcpserversplunk': {
'name': 'string',
'endpoint': 'string',
'authorizationMethod': 'oauth-client-credentials'|'oauth-3lo'|'api-key'|'bearer-token'|'custom-headers',
'description': 'string',
'apiKeyHeader': 'string',
'customHeaderNames': [
'string',
]
},
'mcpservernewrelic': {
'accountId': 'string',
'region': 'US'|'EU'|'JP',
'description': 'string'
},
'azuredevops': {
'organizationName': 'string'
},
'azureidentity': {
'tenantId': 'string',
'clientId': 'string',
'webIdentityRoleArn': 'string',
'webIdentityTokenAudiences': [
'string',
]
},
'mcpservergrafana': {
'endpoint': 'string',
'authorizationMethod': 'oauth-client-credentials'|'oauth-3lo'|'api-key'|'bearer-token'|'custom-headers'
},
'pagerduty': {
'scopes': [
'string',
]
},
'mcpserversigv4': {
'name': 'string',
'endpoint': 'string',
'description': 'string',
'region': 'string',
'service': 'string',
'roleArn': 'string',
'mcpRoleArn': 'string',
'customHeaders': {
'string': 'string'
}
},
'remoteagent': {
'name': 'string',
'endpoint': 'string',
'description': 'string',
'authorizationMethod': 'oauth-client-credentials'|'api-key'|'bearer-token',
'apiKeyHeader': 'string'
},
'remoteagentsigv4': {
'name': 'string',
'endpoint': 'string',
'description': 'string',
'region': 'string',
'service': 'string',
'roleArn': 'string'
}
},
'kmsKeyArn': 'string',
'privateConnectionName': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
Output containing a list of registered services and pagination token.
nextToken (string) --
Token to retrieve the next page of results, if there are more results.
services (list) --
List of registered services.
(dict) --
Represents a registered service with its configuration and accessible resources.
serviceId (string) --
The unique identifier of a service.
serviceType (string) --
The service type e.g github or dynatrace
name (string) --
The display name of the registered service.
accessibleResources (list) --
List of accessible resources for this service.
(:ref:`document<document>`) --
additionalServiceDetails (dict) --
Additional details specific to the service type.
github (dict) --
GitHub-specific service details.
owner (string) --
The GitHub repository owner name.
ownerType (string) --
The GitHub repository owner type.
targetUrl (string) --
The GitHub Enterprise Server instance URL (absent for github.com).
slack (dict) --
Slack-specific service details.
teamId (string) --
The Slack team ID.
teamName (string) --
The Slack team name.
mcpserverdatadog (dict) --
Datadog MCP server-specific service details.
name (string) --
The MCP server name.
endpoint (string) --
The MCP server endpoint URL.
authorizationMethod (string) --
The MCP server uses this authorization method.
description (string) --
Optional description for the MCP server.
apiKeyHeader (string) --
If the MCP server uses API key authentication, these details are provided.
customHeaderNames (list) --
The configured custom authentication header names when the MCP server uses custom-header authentication. Secret values are not returned.
(string) --
HTTP header name. Allows alphanumeric characters, hyphens, and underscores.
mcpserver (dict) --
MCP server-specific service details.
name (string) --
The MCP server name.
endpoint (string) --
The MCP server endpoint URL.
authorizationMethod (string) --
The MCP server uses this authorization method.
description (string) --
Optional description for the MCP server.
apiKeyHeader (string) --
If the MCP server uses API key authentication, these details are provided.
customHeaderNames (list) --
The configured custom authentication header names when the MCP server uses custom-header authentication. Secret values are not returned.
(string) --
HTTP header name. Allows alphanumeric characters, hyphens, and underscores.
servicenow (dict) --
ServiceNow-specific service details.
instanceUrl (string) --
The ServiceNow instance url
gitlab (dict) --
GitLab-specific service details.
targetUrl (string) --
The GitLab instance URL.
tokenType (string) --
Type of GitLab access token
groupId (string) --
Optional GitLab group ID for group-level access tokens
mcpserversplunk (dict) --
Splunk MCP server-specific service details.
name (string) --
The MCP server name.
endpoint (string) --
The MCP server endpoint URL.
authorizationMethod (string) --
The MCP server uses this authorization method.
description (string) --
Optional description for the MCP server.
apiKeyHeader (string) --
If the MCP server uses API key authentication, these details are provided.
customHeaderNames (list) --
The configured custom authentication header names when the MCP server uses custom-header authentication. Secret values are not returned.
(string) --
HTTP header name. Allows alphanumeric characters, hyphens, and underscores.
mcpservernewrelic (dict) --
New Relic MCP server-specific service details.
accountId (string) --
The NewRelic account ID.
region (string) --
The NewRelic region (determines API endpoint).
description (string) --
Optional user description.
azuredevops (dict) --
Azure DevOps specific service details.
organizationName (string) --
The Azure DevOps Organization name associated with the service.
azureidentity (dict) --
Azure identity details for services using Azure authentication.
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) --
mcpservergrafana (dict) --
Grafana MCP server-specific service details.
endpoint (string) --
Grafana instance URL (e.g., https://your-instance.grafana.net)
authorizationMethod (string) --
The authz method used by the MCP server.
pagerduty (dict) --
Pagerduty service details.
scopes (list) --
The scopes that were assigned to the service
(string) --
mcpserversigv4 (dict) --
SigV4-authenticated MCP server-specific service details.
name (string) --
MCP server name.
endpoint (string) --
MCP server endpoint URL.
description (string) --
Optional description for the MCP server.
region (string) --
AWS region for SigV4 signing. Use '*' for SigV4a multi-region signing.
service (string) --
AWS service name for SigV4 signing.
roleArn (string) --
IAM role ARN to assume for SigV4 signing.
mcpRoleArn (string) --
AWS IAM role ARN.
customHeaders (dict) --
Custom headers for the SigV4 MCP server.
(string) --
HTTP header name. Allows alphanumeric characters, hyphens, and underscores.
(string) --
Value type for custom headers.
remoteagent (dict) --
Remote A2A agent-specific service details (token-based auth).
name (string) --
Name identifier for a remote A2A agent.
endpoint (string) --
HTTPS endpoint URL for a remote A2A agent.
description (string) --
Description field
authorizationMethod (string) --
The authorization method used by the remote agent.
apiKeyHeader (string) --
If the remote agent uses API key authentication, the header name.
remoteagentsigv4 (dict) --
Remote A2A agent-specific service details (SigV4 auth).
name (string) --
Name identifier for a remote A2A agent.
endpoint (string) --
HTTPS endpoint URL for a remote A2A agent.
description (string) --
Description field
region (string) --
AWS region identifier or wildcard (*) for SigV4a multi-region signing.
service (string) --
The AWS service name for SigV4 signing.
roleArn (string) --
AWS IAM role ARN.
kmsKeyArn (string) --
The ARN of the AWS Key Management Service (AWS KMS) customer managed key that's used to encrypt resources.
privateConnectionName (string) --
The name of the private connection used for VPC connectivity.
createdAt (datetime) --
The timestamp when the service was registered.
updatedAt (datetime) --
The timestamp when the service was last updated.
{'serviceDetails': {'mcpserver': {'authorizationConfig': {'customHeaders': {'headers': {'string': 'string'}}}},
'mcpservergrafana': {'authorizationConfig': {'customHeaders': {'headers': {'string': 'string'}}}},
'mcpserversplunk': {'authorizationConfig': {'customHeaders': {'headers': {'string': 'string'}}}}}}
This operation registers the specified service
See also: AWS API Documentation
Request Syntax
client.register_service(
service='dynatrace'|'servicenow'|'pagerduty'|'gitlab'|'eventChannel'|'mcpservernewrelic'|'mcpservergrafana'|'mcpserverdatadog'|'mcpserver'|'mcpserversplunk'|'azureidentity'|'mcpserversigv4'|'remoteagent'|'remoteagentsigv4',
serviceDetails={
'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'
},
'customHeaders': {
'headers': {
'string': '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'
},
'customHeaders': {
'headers': {
'string': 'string'
}
},
'authorizationDiscovery': {
'returnToEndpoint': 'string'
}
}
},
'mcpservernewrelic': {
'authorizationConfig': {
'apiKey': {
'apiKey': 'string',
'accountId': 'string',
'region': 'US'|'EU'|'JP',
'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'
},
'customHeaders': {
'headers': {
'string': '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',
]
},
'mcpserversigv4': {
'name': 'string',
'endpoint': 'string',
'description': 'string',
'authorizationConfig': {
'region': 'string',
'service': 'string',
'roleArn': 'string',
'mcpRoleArn': 'string',
'customHeaders': {
'string': 'string'
}
}
},
'remoteagent': {
'name': 'string',
'endpoint': 'string',
'description': 'string',
'authorizationConfig': {
'apiKey': {
'apiKeyName': 'string',
'apiKeyValue': 'string',
'apiKeyHeader': 'string'
},
'oAuthClientCredentials': {
'clientName': 'string',
'clientId': 'string',
'exchangeParameters': {
'string': 'string'
},
'clientSecret': 'string',
'exchangeUrl': 'string',
'scopes': [
'string',
]
},
'bearerToken': {
'tokenName': 'string',
'tokenValue': 'string',
'authorizationHeader': 'string'
}
}
},
'remoteagentsigv4': {
'name': 'string',
'endpoint': 'string',
'description': 'string',
'authorizationConfig': {
'region': 'string',
'service': 'string',
'roleArn': 'string'
}
}
},
kmsKeyArn='string',
privateConnectionName='string',
targetUrlPrivateConnectionName='string',
exchangeUrlPrivateConnectionName='string',
name='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
Services that can be registered via the post-registration API (excludes OAuth 3LO services).
dict
[REQUIRED]
Service-specific authorization configuration parameters
dynatrace (dict) --
Dynatrace-specific service details.
accountUrn (string) -- [REQUIRED]
Dynatrace resource account urn.
authorizationConfig (dict) --
Dynatrace OAuth client credentials configuration. Use this when registering with OAuth client credentials flow.
oAuthClientCredentials (dict) --
OAuth client credentials configuration.
clientName (string) --
User friendly OAuth client name specified by end user.
clientId (string) -- [REQUIRED]
OAuth client ID for authenticating with the service.
exchangeParameters (dict) --
OAuth token exchange parameters for authenticating with the service.
(string) --
(string) --
Exchange Parameter value for MCP authentication
clientSecret (string) -- [REQUIRED]
OAuth client secret for authenticating with the service.
servicenow (dict) --
ServiceNow-specific service details.
instanceUrl (string) -- [REQUIRED]
ServiceNow instance URL.
authorizationConfig (dict) --
ServiceNow OAuth client credentials configuration. Use this when registering with OAuth client credentials flow.
oAuthClientCredentials (dict) --
OAuth client credentials configuration.
clientName (string) --
User friendly OAuth client name specified by end user.
clientId (string) -- [REQUIRED]
OAuth client ID for authenticating with the service.
exchangeParameters (dict) --
OAuth token exchange parameters for authenticating with the service.
(string) --
(string) --
Exchange Parameter value for MCP authentication
clientSecret (string) -- [REQUIRED]
OAuth client secret for authenticating with the service.
mcpserverdatadog (dict) --
Datadog MCP server-specific service details.
name (string) -- [REQUIRED]
MCP server name.
endpoint (string) -- [REQUIRED]
MCP server endpoint URL.
description (string) --
Optional description for the MCP server.
authorizationConfig (dict) -- [REQUIRED]
Datadog MCP server authorization configuration (only authorization discovery is supported).
authorizationDiscovery (dict) --
Datadog MCP server authorization discovery configuration.
returnToEndpoint (string) -- [REQUIRED]
The endpoint to return to after OAuth flow completes (must be AWS console domain)
mcpserver (dict) --
MCP server-specific service details.
name (string) -- [REQUIRED]
MCP server name.
endpoint (string) -- [REQUIRED]
MCP server endpoint URL.
description (string) --
Optional description for the MCP server.
authorizationConfig (dict) -- [REQUIRED]
MCP server authorization configuration.
oAuthClientCredentials (dict) --
MCP server configuration with OAuth client credentials.
clientName (string) --
User friendly OAuth client name specified by end user.
clientId (string) -- [REQUIRED]
OAuth client ID for authenticating with the service.
exchangeParameters (dict) --
OAuth token exchange parameters for authenticating with the service.
(string) --
(string) --
Exchange Parameter value for MCP authentication
clientSecret (string) -- [REQUIRED]
OAuth client secret for authenticating with the service.
exchangeUrl (string) -- [REQUIRED]
OAuth token exchange URL.
scopes (list) --
OAuth scopes for 3LO authentication. The service will always request scope offline_access.
(string) --
OAuth scope parameter
oAuth3LO (dict) --
MCP server configuration with OAuth 3LO.
clientName (string) --
User friendly OAuth client name specified by end user.
clientId (string) -- [REQUIRED]
OAuth client ID for authenticating with the service.
exchangeParameters (dict) --
OAuth token exchange parameters for authenticating with the service.
(string) --
(string) --
Exchange Parameter value for MCP authentication
returnToEndpoint (string) -- [REQUIRED]
The endpoint to return to after OAuth flow completes (must be AWS console domain)
authorizationUrl (string) -- [REQUIRED]
OAuth authorization URL for 3LO authentication.
exchangeUrl (string) -- [REQUIRED]
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) --
OAuth scope parameter
apiKey (dict) --
MCP server configuration with API key authentication.
apiKeyName (string) -- [REQUIRED]
User friendly API key name specified by end user.
apiKeyValue (string) -- [REQUIRED]
API key value for authenticating with the service.
apiKeyHeader (string) -- [REQUIRED]
HTTP header name to send the API key in requests to the service.
bearerToken (dict) --
MCP server configuration with Bearer token (RFC 6750).
tokenName (string) -- [REQUIRED]
User friendly bearer token name specified by end user.
tokenValue (string) -- [REQUIRED]
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.
customHeaders (dict) --
MCP server configuration with one or more custom authentication headers.
headers (dict) -- [REQUIRED]
Custom headers map.
(string) --
HTTP header name. Allows alphanumeric characters, hyphens, and underscores.
(string) --
Value type for custom headers.
authorizationDiscovery (dict) --
MCP server authorization discovery configuration.
returnToEndpoint (string) -- [REQUIRED]
The endpoint to return to after OAuth flow completes (must be AWS console domain)
gitlab (dict) --
GitLab-specific service details.
targetUrl (string) -- [REQUIRED]
GitLab instance URL (e.g., https://gitlab.com or self-hosted instance).
tokenType (string) -- [REQUIRED]
Type of GitLab access token
tokenValue (string) -- [REQUIRED]
GitLab access token value
groupId (string) --
Optional GitLab group ID for group-level access tokens
mcpserversplunk (dict) --
Splunk MCP server-specific service details.
name (string) -- [REQUIRED]
MCP server name.
endpoint (string) -- [REQUIRED]
MCP server endpoint URL.
description (string) --
Optional description for the MCP server.
authorizationConfig (dict) -- [REQUIRED]
MCP server authorization configuration.
oAuthClientCredentials (dict) --
MCP server configuration with OAuth client credentials.
clientName (string) --
User friendly OAuth client name specified by end user.
clientId (string) -- [REQUIRED]
OAuth client ID for authenticating with the service.
exchangeParameters (dict) --
OAuth token exchange parameters for authenticating with the service.
(string) --
(string) --
Exchange Parameter value for MCP authentication
clientSecret (string) -- [REQUIRED]
OAuth client secret for authenticating with the service.
exchangeUrl (string) -- [REQUIRED]
OAuth token exchange URL.
scopes (list) --
OAuth scopes for 3LO authentication. The service will always request scope offline_access.
(string) --
OAuth scope parameter
oAuth3LO (dict) --
MCP server configuration with OAuth 3LO.
clientName (string) --
User friendly OAuth client name specified by end user.
clientId (string) -- [REQUIRED]
OAuth client ID for authenticating with the service.
exchangeParameters (dict) --
OAuth token exchange parameters for authenticating with the service.
(string) --
(string) --
Exchange Parameter value for MCP authentication
returnToEndpoint (string) -- [REQUIRED]
The endpoint to return to after OAuth flow completes (must be AWS console domain)
authorizationUrl (string) -- [REQUIRED]
OAuth authorization URL for 3LO authentication.
exchangeUrl (string) -- [REQUIRED]
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) --
OAuth scope parameter
apiKey (dict) --
MCP server configuration with API key authentication.
apiKeyName (string) -- [REQUIRED]
User friendly API key name specified by end user.
apiKeyValue (string) -- [REQUIRED]
API key value for authenticating with the service.
apiKeyHeader (string) -- [REQUIRED]
HTTP header name to send the API key in requests to the service.
bearerToken (dict) --
MCP server configuration with Bearer token (RFC 6750).
tokenName (string) -- [REQUIRED]
User friendly bearer token name specified by end user.
tokenValue (string) -- [REQUIRED]
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.
customHeaders (dict) --
MCP server configuration with one or more custom authentication headers.
headers (dict) -- [REQUIRED]
Custom headers map.
(string) --
HTTP header name. Allows alphanumeric characters, hyphens, and underscores.
(string) --
Value type for custom headers.
authorizationDiscovery (dict) --
MCP server authorization discovery configuration.
returnToEndpoint (string) -- [REQUIRED]
The endpoint to return to after OAuth flow completes (must be AWS console domain)
mcpservernewrelic (dict) --
New Relic-specific service details.
authorizationConfig (dict) -- [REQUIRED]
New Relic MCP server authorization configuration.
apiKey (dict) --
New Relic API Key authentication (apiKey, accountId, region).
apiKey (string) -- [REQUIRED]
New Relic User API Key
accountId (string) -- [REQUIRED]
New Relic Account ID
region (string) -- [REQUIRED]
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 (dict) --
Event Channel specific service details.
type (string) --
The type of event channel
mcpservergrafana (dict) --
Datadog MCP server-specific service details.
name (string) -- [REQUIRED]
MCP server name.
endpoint (string) -- [REQUIRED]
MCP server endpoint URL.
description (string) --
Optional description for the MCP server.
authorizationConfig (dict) -- [REQUIRED]
Grafana MCP server authorization configuration (experimental).
oAuthClientCredentials (dict) --
MCP server configuration with OAuth client credentials.
clientName (string) --
User friendly OAuth client name specified by end user.
clientId (string) -- [REQUIRED]
OAuth client ID for authenticating with the service.
exchangeParameters (dict) --
OAuth token exchange parameters for authenticating with the service.
(string) --
(string) --
Exchange Parameter value for MCP authentication
clientSecret (string) -- [REQUIRED]
OAuth client secret for authenticating with the service.
exchangeUrl (string) -- [REQUIRED]
OAuth token exchange URL.
scopes (list) --
OAuth scopes for 3LO authentication. The service will always request scope offline_access.
(string) --
OAuth scope parameter
oAuth3LO (dict) --
MCP server configuration with OAuth 3LO.
clientName (string) --
User friendly OAuth client name specified by end user.
clientId (string) -- [REQUIRED]
OAuth client ID for authenticating with the service.
exchangeParameters (dict) --
OAuth token exchange parameters for authenticating with the service.
(string) --
(string) --
Exchange Parameter value for MCP authentication
returnToEndpoint (string) -- [REQUIRED]
The endpoint to return to after OAuth flow completes (must be AWS console domain)
authorizationUrl (string) -- [REQUIRED]
OAuth authorization URL for 3LO authentication.
exchangeUrl (string) -- [REQUIRED]
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) --
OAuth scope parameter
apiKey (dict) --
MCP server configuration with API key authentication.
apiKeyName (string) -- [REQUIRED]
User friendly API key name specified by end user.
apiKeyValue (string) -- [REQUIRED]
API key value for authenticating with the service.
apiKeyHeader (string) -- [REQUIRED]
HTTP header name to send the API key in requests to the service.
bearerToken (dict) --
MCP server configuration with Bearer token (RFC 6750).
tokenName (string) -- [REQUIRED]
User friendly bearer token name specified by end user.
tokenValue (string) -- [REQUIRED]
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.
customHeaders (dict) --
MCP server configuration with one or more custom authentication headers.
headers (dict) -- [REQUIRED]
Custom headers map.
(string) --
HTTP header name. Allows alphanumeric characters, hyphens, and underscores.
(string) --
Value type for custom headers.
authorizationDiscovery (dict) --
MCP server authorization discovery configuration.
returnToEndpoint (string) -- [REQUIRED]
The endpoint to return to after OAuth flow completes (must be AWS console domain)
pagerduty (dict) --
PagerDuty specific service details.
scopes (list) -- [REQUIRED]
PagerDuty scopes.
(string) --
authorizationConfig (dict) -- [REQUIRED]
PagerDuty authorization configuration
oAuthClientCredentials (dict) --
OAuth client credentials configuration.
clientName (string) --
User friendly OAuth client name specified by end user.
clientId (string) -- [REQUIRED]
OAuth client ID for authenticating with the service.
exchangeParameters (dict) --
OAuth token exchange parameters for authenticating with the service.
(string) --
(string) --
Exchange Parameter value for MCP authentication
clientSecret (string) -- [REQUIRED]
OAuth client secret for authenticating with the service.
azureidentity (dict) --
Azure integration with AWS Outbound Identity Federation specific service details.
tenantId (string) -- [REQUIRED]
The Azure Active Directory tenant ID for the identity.
clientId (string) -- [REQUIRED]
The client ID of the service principal or managed identity used for authentication.
webIdentityRoleArn (string) -- [REQUIRED]
The role ARN to be assumed by DevOps Agent for requesting Web Identity Token.
webIdentityTokenAudiences (list) -- [REQUIRED]
The audiences for the Web Identity Token.
(string) --
mcpserversigv4 (dict) --
SigV4-authenticated MCP server-specific service details.
name (string) -- [REQUIRED]
MCP server name.
endpoint (string) -- [REQUIRED]
MCP server endpoint URL.
description (string) --
Optional description for the MCP server.
authorizationConfig (dict) -- [REQUIRED]
MCP Server SigV4 authorization configuration.
region (string) -- [REQUIRED]
AWS region for SigV4 signing. Use '*' for SigV4a multi-region signing.
service (string) -- [REQUIRED]
AWS service name for SigV4 signing.
roleArn (string) --
Deprecated — use mcpRoleArn instead. IAM role ARN to assume for SigV4 signing.
mcpRoleArn (string) --
IAM role ARN to assume for SigV4 signing. Optional — when omitted, credentials are resolved at runtime via a monitor account association.
customHeaders (dict) --
Custom headers for the SigV4 MCP server.
(string) --
HTTP header name. Allows alphanumeric characters, hyphens, and underscores.
(string) --
Value type for custom headers.
remoteagent (dict) --
Remote A2A agent service details (token-based auth).
name (string) -- [REQUIRED]
Name identifier for a remote A2A agent.
endpoint (string) -- [REQUIRED]
HTTPS endpoint URL for a remote A2A agent.
description (string) --
Description field
authorizationConfig (dict) -- [REQUIRED]
Remote agent authorization configuration.
apiKey (dict) --
Remote agent configuration with API key authentication.
apiKeyName (string) -- [REQUIRED]
User friendly API key name specified by end user.
apiKeyValue (string) -- [REQUIRED]
API key value for authenticating with the service.
apiKeyHeader (string) -- [REQUIRED]
HTTP header name to send the API key in requests to the service.
oAuthClientCredentials (dict) --
Remote agent configuration with OAuth client credentials.
clientName (string) --
User friendly OAuth client name specified by end user.
clientId (string) -- [REQUIRED]
OAuth client ID for authenticating with the service.
exchangeParameters (dict) --
OAuth token exchange parameters for authenticating with the service.
(string) --
(string) --
Exchange Parameter value for MCP authentication
clientSecret (string) -- [REQUIRED]
OAuth client secret for authenticating with the service.
exchangeUrl (string) -- [REQUIRED]
OAuth token exchange URL.
scopes (list) --
OAuth scopes for authentication.
(string) --
OAuth scope parameter
bearerToken (dict) --
Remote agent configuration with Bearer token (RFC 6750).
tokenName (string) -- [REQUIRED]
User friendly bearer token name specified by end user.
tokenValue (string) -- [REQUIRED]
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.
remoteagentsigv4 (dict) --
Remote A2A agent service details (SigV4 auth).
name (string) -- [REQUIRED]
Name identifier for a remote A2A agent.
endpoint (string) -- [REQUIRED]
HTTPS endpoint URL for a remote A2A agent.
description (string) --
Description field
authorizationConfig (dict) -- [REQUIRED]
Remote agent SigV4 authorization configuration.
region (string) -- [REQUIRED]
AWS region identifier or wildcard (*) for SigV4a multi-region signing.
service (string) -- [REQUIRED]
The AWS service name for SigV4 signing.
roleArn (string) --
AWS IAM role ARN.
string
The ARN of the AWS Key Management Service (AWS KMS) customer managed key that's used to encrypt resources.
string
The name of the private connection to use for VPC connectivity.
string
The name of the private connection to use for API calls (target URL) only. Cannot be specified when privateConnectionName is provided.
string
The name of the private connection to use for OAuth token exchange requests only. Cannot be specified when privateConnectionName is provided.
string
The display name for the service registration.
dict
Tags to add to the Service at registration time.
(string) --
Tag key string.
(string) --
Tag value string.
dict
Response Syntax
{
'serviceId': 'string',
'additionalStep': {
'oauth': {
'authorizationUrl': 'string'
}
},
'kmsKeyArn': 'string',
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Output containing the service ID and any additional steps required for registration.
serviceId (string) --
Service ID - present when registration is complete, absent when additional steps are required
additionalStep (dict) --
Indicates if additional steps are required to complete service registration (e.g., 3-legged OAuth)
oauth (dict) --
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 (dict) --
Tags associated with the registered Service.
(string) --
Tag key string.
(string) --
Tag value string.