2026/03/30 - AWS DevOps Agent Service - 48 new api methods
Changes AWS DevOps Agent General Availability.
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
},
'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.
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.
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.
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
Deletes a Private Connection. The deletion is asynchronous and returns DELETE_IN_PROGRESS status.
See also: AWS API Documentation
Request Syntax
client.delete_private_connection(
name='string'
)
string
[REQUIRED]
The name of the Private Connection.
dict
Response Syntax
{
'name': 'string',
'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED'
}
Response Structure
(dict) --
Output containing the status of the Private Connection deletion.
name (string) --
The name of the Private Connection.
status (string) --
The status of the Private Connection.
List journal records for a specific execution
See also: AWS API Documentation
Request Syntax
client.list_journal_records(
agentSpaceId='string',
executionId='string',
limit=123,
nextToken='string',
recordType='string',
order='ASC'|'DESC'
)
string
[REQUIRED]
The unique identifier for the agent space containing the execution
string
[REQUIRED]
The unique identifier of the execution whose journal records to retrieve
integer
Maximum number of records to return in a single response (1-100, default: 100)
string
Token for retrieving the next page of results
string
Filter records by type (empty string returns all types)
string
Sort order for the records based on timestamp (default: DESC)
dict
Response Syntax
{
'records': [
{
'agentSpaceId': 'string',
'executionId': 'string',
'recordId': 'string',
'content': {...}|[...]|123|123.4|'string'|True|None,
'createdAt': datetime(2015, 1, 1),
'recordType': 'string',
'userReference': {
'userId': 'string',
'userType': 'IAM'|'IDC'|'IDP'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Response structure containing a list of journal records
records (list) --
List of journal records matching the request criteria
(dict) --
Represents a journal record containing execution details and content
agentSpaceId (string) --
The unique identifier for the agent space containing this record
executionId (string) --
The execution ID associated with this journal record
recordId (string) --
The unique identifier for this journal record
content (:ref:`document<document>`) --
The content of this journal record
createdAt (datetime) --
Timestamp when this journal record was created
recordType (string) --
The type of this journal record
userReference (dict) --
Reference to the user associated with this journal record
userId (string) --
The unique identifier for the user
userType (string) --
The type of user
nextToken (string) --
Token for retrieving the next page of results, if more results are available
Retrieves details of an existing Private Connection.
See also: AWS API Documentation
Request Syntax
client.describe_private_connection(
name='string'
)
string
[REQUIRED]
The name of the Private Connection.
dict
Response Syntax
{
'name': 'string',
'type': 'SELF_MANAGED'|'SERVICE_MANAGED',
'resourceGatewayId': 'string',
'hostAddress': 'string',
'vpcId': 'string',
'resourceConfigurationId': 'string',
'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED',
'certificateExpiryTime': datetime(2015, 1, 1),
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Output containing the Private Connection details.
name (string) --
The name of the Private Connection.
type (string) --
The type of the Private Connection.
resourceGatewayId (string) --
The service-managed Resource Gateway ARN. Only present for service-managed Private Connections.
hostAddress (string) --
IP address or DNS name of the target resource. Only present for service-managed Private Connections.
vpcId (string) --
VPC identifier of the service-managed Resource Gateway. Only present for service-managed Private Connections.
resourceConfigurationId (string) --
The Resource Configuration ARN. Only present for self-managed Private Connections.
status (string) --
The status of the Private Connection.
certificateExpiryTime (datetime) --
The expiry time of the certificate associated with the Private Connection. Only present when a certificate is associated.
tags (dict) --
Tags associated with the Private Connection.
(string) --
Tag key string.
(string) --
Tag value string.
Sends a chat message and streams the response for the specified agent space execution
See also: AWS API Documentation
Request Syntax
client.send_message(
agentSpaceId='string',
executionId='string',
content='string',
context={
'currentPage': 'string',
'lastMessage': 'string',
'userActionResponse': 'string'
},
userId='string'
)
string
[REQUIRED]
The agent space identifier
string
[REQUIRED]
The execution identifier for the chat session
string
[REQUIRED]
The user message content
dict
Optional context for the message
currentPage (string) --
The current page or view the user is on
lastMessage (string) --
The ID of the last message in the conversation
userActionResponse (string) --
Response to a UI prompt (not a text conversation message)
string
[REQUIRED]
Required user identifier
dict
The response of this operation contains an :class:`.EventStream` member. When iterated the :class:`.EventStream` will yield events based on the structure below, where only one of the top level keys will be present for any given event.
Response Syntax
{
'events': EventStream({
'responseCreated': {
'responseId': 'string',
'sequenceNumber': 123
},
'responseInProgress': {
'responseId': 'string',
'sequenceNumber': 123
},
'responseCompleted': {
'responseId': 'string',
'usage': {
'inputTokens': 123,
'outputTokens': 123,
'totalTokens': 123
},
'sequenceNumber': 123
},
'responseFailed': {
'responseId': 'string',
'errorCode': 'string',
'errorMessage': 'string',
'sequenceNumber': 123
},
'summary': {
'content': 'string',
'sequenceNumber': 123
},
'heartbeat': {},
'contentBlockStart': {
'index': 123,
'type': 'string',
'id': 'string',
'parentId': 'string',
'sequenceNumber': 123
},
'contentBlockDelta': {
'index': 123,
'delta': {
'textDelta': {
'text': 'string'
},
'jsonDelta': {
'partialJson': 'string'
}
},
'sequenceNumber': 123
},
'contentBlockStop': {
'index': 123,
'type': 'string',
'text': 'string',
'last': True|False,
'sequenceNumber': 123
}
})
}
Response Structure
(dict) --
Response structure for sending chat message events
events (:class:`.EventStream`) --
The stream of chat message events
responseCreated (dict) --
Emitted when the response is created
responseId (string) --
The response ID
sequenceNumber (integer) --
Event sequence number
responseInProgress (dict) --
Emitted while the response is being generated
responseId (string) --
The response ID
sequenceNumber (integer) --
Event sequence number
responseCompleted (dict) --
Emitted when the response completes successfully
responseId (string) --
The response ID
usage (dict) --
Token usage information
inputTokens (integer) --
Number of input tokens
outputTokens (integer) --
Number of output tokens
totalTokens (integer) --
Total tokens used
sequenceNumber (integer) --
Event sequence number
responseFailed (dict) --
Emitted when the response fails
responseId (string) --
The response ID
errorCode (string) --
Error code
errorMessage (string) --
Error message
sequenceNumber (integer) --
Event sequence number
summary (dict) --
Emitted to provide a summary of agent actions
content (string) --
Summary content
sequenceNumber (integer) --
Event sequence number
heartbeat (:class:`.EventStream`) --
Heartbeat event sent periodically to keep the connection alive during idle periods
contentBlockStart (dict) --
Emitted when a new content block starts
index (integer) --
Zero-based index of the content block
type (string) --
The type of content in this block
id (string) --
Block identifier
parentId (string) --
Optional parent block ID for nested content blocks (e.g. subagent tool calls)
sequenceNumber (integer) --
Event sequence number
contentBlockDelta (dict) --
Emitted for each incremental content delta within a content block
index (integer) --
Zero-based index of the content block
delta (dict) --
The incremental content delta
textDelta (dict) --
Text delta for text-based content blocks
text (string) --
The text fragment
jsonDelta (dict) --
JSON delta for structured content blocks
partialJson (string) --
Partial JSON string
sequenceNumber (integer) --
Event sequence number
contentBlockStop (dict) --
Emitted when a content block is complete
index (integer) --
Zero-based index of the content block
type (string) --
The type of content in this block
text (string) --
The accumulated complete content text
last (boolean) --
Whether this is the final content block in the response
sequenceNumber (integer) --
Event sequence number
Update the external Identity Provider configuration for the Operator App
See also: AWS API Documentation
Request Syntax
client.update_operator_app_idp_config(
agentSpaceId='string',
idpClientSecret='string'
)
string
[REQUIRED]
The unique identifier of the AgentSpace
string
The OIDC client secret for the IdP application
dict
Response Syntax
{
'agentSpaceId': 'string',
'idp': {
'issuerUrl': 'string',
'clientId': 'string',
'operatorAppRoleArn': 'string',
'provider': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Output containing the updated IdP configuration.
agentSpaceId (string) --
The unique identifier of the AgentSpace
idp (dict) --
Configuration for external Identity Provider OIDC authentication flow for the Operator App.
issuerUrl (string) --
The OIDC issuer URL of the external Identity Provider
clientId (string) --
The OIDC client ID for the IdP application
operatorAppRoleArn (string) --
The IAM role end users assume to access AIDevOps APIs
provider (string) --
The Identity Provider name (e.g., Entra, Okta, Google)
createdAt (datetime) --
The timestamp when the Operator App IdP auth flow was enabled.
updatedAt (datetime) --
The timestamp when the Operator App IdP auth flow was updated.
Lists all AgentSpaces with optional pagination.
See also: AWS API Documentation
Request Syntax
client.list_agent_spaces(
maxResults=123,
nextToken='string'
)
integer
Maximum number of results to return in a single call.
string
Token for the next page of results.
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'
},
]
}
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
Lists goals in the specified agent space with optional filtering
See also: AWS API Documentation
Request Syntax
client.list_goals(
agentSpaceId='string',
status='ACTIVE'|'PAUSED'|'COMPLETE',
goalType='CUSTOMER_DEFINED'|'ONCALL_REPORT',
limit=123,
nextToken='string'
)
string
[REQUIRED]
The unique identifier for the agent space
string
Filter goals by goal status
string
Filter goals by goal type
integer
Maximum number of goals to return
string
Pagination token for the next set of results
dict
Response Syntax
{
'goals': [
{
'agentSpaceArn': 'string',
'goalId': 'string',
'title': 'string',
'content': {
'description': 'string',
'objectives': 'string'
},
'status': 'ACTIVE'|'PAUSED'|'COMPLETE',
'goalType': 'CUSTOMER_DEFINED'|'ONCALL_REPORT',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'lastEvaluatedAt': datetime(2015, 1, 1),
'lastTaskId': 'string',
'lastSuccessfulTaskId': 'string',
'version': 123,
'evaluationSchedule': {
'state': 'ENABLED'|'DISABLED',
'expression': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Response structure containing the list of goals
goals (list) --
List of goals matching the criteria
(dict) --
Represents a goal with all its properties and metadata
agentSpaceArn (string) --
The unique identifier for the agent space containing this goal
goalId (string) --
The unique identifier for this goal
title (string) --
The title of the goal
content (dict) --
Content of the goal
description (string) --
A detailed description of the goal.
objectives (string) --
The objectives to be achieved for this goal.
status (string) --
Current status of the goal itself
goalType (string) --
Type of goal based on its origin
createdAt (datetime) --
Timestamp when this goal was created
updatedAt (datetime) --
Timestamp when this goal was last updated
lastEvaluatedAt (datetime) --
Timestamp when the goal was last evaluated
lastTaskId (string) --
ID of the most recent task associated with this goal
lastSuccessfulTaskId (string) --
ID of the most recent successful task associated with this goal
version (integer) --
Version number for optimistic locking
evaluationSchedule (dict) --
Goal Schedule. Allows to schedule the goal to run periodically, as well as disable a goal temporarily
state (string) --
Whether the schedule is enabled or disabled
expression (string) --
Schedule expression (e.g., 'rate(7 days)')
nextToken (string) --
Pagination token for the next set of results
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',
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'
},
'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',
]
},
'mcpserversigv4': {
'name': 'string',
'endpoint': 'string',
'description': 'string',
'authorizationConfig': {
'region': 'string',
'service': 'string',
'roleArn': 'string'
}
}
},
kmsKeyArn='string',
privateConnectionName='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) --
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) --
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.
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) --
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) --
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.
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) --
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) --
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.
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.
service (string) -- [REQUIRED]
AWS service name for SigV4 signing.
roleArn (string) -- [REQUIRED]
IAM role ARN to assume for SigV4 signing.
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 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.
Lists backlog tasks in the specified agent space with optional filtering and sorting
See also: AWS API Documentation
Request Syntax
client.list_backlog_tasks(
agentSpaceId='string',
filter={
'createdAfter': datetime(2015, 1, 1),
'createdBefore': datetime(2015, 1, 1),
'priority': [
'CRITICAL'|'HIGH'|'MEDIUM'|'LOW'|'MINIMAL',
],
'status': [
'PENDING_TRIAGE'|'LINKED'|'PENDING_START'|'IN_PROGRESS'|'PENDING_CUSTOMER_APPROVAL'|'COMPLETED'|'FAILED'|'TIMED_OUT'|'CANCELED',
],
'taskType': [
'INVESTIGATION'|'EVALUATION',
],
'primaryTaskId': 'string'
},
limit=123,
nextToken='string',
sortField='CREATED_AT'|'PRIORITY',
order='ASC'|'DESC'
)
string
[REQUIRED]
The unique identifier for the agent space containing the tasks
dict
Filter criteria to apply when listing tasks
Filtering restrictions:
Each filter field list is limited to a single value
Filtering by Priority and Status at the same time when not filtering by Type is not permitted
Timestamp filters (createdAfter, createdBefore) can be combined with other filters when not sorting by priority
createdAfter (datetime) --
Filter for tasks created after this timestamp inclusive
createdBefore (datetime) --
Filter for tasks created before this timestamp exclusive
priority (list) --
Filter by priority (single value only)
(string) --
Priority levels for tasks, from highest to lowest urgency
status (list) --
Filter by status (single value only)
(string) --
Possible states of a task throughout its lifecycle
taskType (list) --
Filter by task type (single value only)
(string) --
Types of tasks that can be created in the backlog
primaryTaskId (string) --
Filter by primary task ID to get linked tasks
integer
Maximum number of tasks to return in a single response (1-1000, default: 100)
string
Token for retrieving the next page of results
string
Field to sort by
``Sorting restrictions: ``
Only sorting on createdAt is supported when using priority or status filters alone.
Sorting by priority is not supported when using Timestamp filters (createdAfter, createdBefore)
string
Sort order for the tasks based on sortField (default: DESC)
dict
Response Syntax
{
'tasks': [
{
'agentSpaceId': 'string',
'taskId': 'string',
'executionId': 'string',
'title': 'string',
'description': 'string',
'reference': {
'system': 'string',
'title': 'string',
'referenceId': 'string',
'referenceUrl': 'string',
'associationId': 'string'
},
'taskType': 'INVESTIGATION'|'EVALUATION',
'priority': 'CRITICAL'|'HIGH'|'MEDIUM'|'LOW'|'MINIMAL',
'status': 'PENDING_TRIAGE'|'LINKED'|'PENDING_START'|'IN_PROGRESS'|'PENDING_CUSTOMER_APPROVAL'|'COMPLETED'|'FAILED'|'TIMED_OUT'|'CANCELED',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'version': 123,
'supportMetadata': {...}|[...]|123|123.4|'string'|True|None,
'metadata': {...}|[...]|123|123.4|'string'|True|None,
'primaryTaskId': 'string',
'statusReason': 'string',
'hasLinkedTasks': True|False
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Response structure containing a list of backlog tasks
tasks (list) --
List of backlog tasks
(dict) --
Represents a backlog task with all its properties and metadata
agentSpaceId (string) --
The unique identifier for the agent space containing this task
taskId (string) --
The unique identifier for this task
executionId (string) --
The execution ID associated with this task, if any
title (string) --
The title of the task
description (string) --
Optional detailed description of the task
reference (dict) --
Optional reference information linking this task to external systems
system (string) --
The name of the external system
title (string) --
Optional title for the reference
referenceId (string) --
The unique identifier in the external system
referenceUrl (string) --
URL to access the reference in the external system
associationId (string) --
Association identifier of the external system
taskType (string) --
The type of this task
priority (string) --
The priority level of this task
status (string) --
The current status of this task
createdAt (datetime) --
Timestamp when this task was created
updatedAt (datetime) --
Timestamp when this task was last updated
version (integer) --
Version number for optimistic locking
supportMetadata (:ref:`document<document>`) --
Optional support metadata for the task
metadata (:ref:`document<document>`) --
Optional metadata for the task
primaryTaskId (string) --
The task ID of the primary investigation this task is linked to
statusReason (string) --
Explanation for why the task status was changed (e.g., linked reason)
hasLinkedTasks (boolean) --
Indicates if this task has other tasks linked to it
nextToken (string) --
Token for retrieving the next page of results, if more results are available
Removes tags from the specified AWS DevOps Agent resource.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
string
[REQUIRED]
The ARN of the resource to untag.
list
[REQUIRED]
Tag keys to remove.
(string) --
Tag key string.
dict
Response Syntax
{}
Response Structure
(dict) --
Adds a specific service association to an AgentSpace. It overwrites the existing association of the same service. Returns 201 Created on success.
See also: AWS API Documentation
Request Syntax
client.associate_service(
agentSpaceId='string',
serviceId='string',
configuration={
'sourceAws': {
'accountId': 'string',
'accountType': 'source',
'assumableRoleArn': 'string',
'externalId': 'string'
},
'aws': {
'assumableRoleArn': 'string',
'accountId': 'string',
'accountType': 'monitor'
},
'github': {
'repoName': 'string',
'repoId': 'string',
'owner': 'string',
'ownerType': 'organization'|'user',
'instanceIdentifier': 'string'
},
'slack': {
'workspaceId': 'string',
'workspaceName': 'string',
'transmissionTarget': {
'opsOncallTarget': {
'channelName': 'string',
'channelId': 'string'
},
'opsSRETarget': {
'channelName': 'string',
'channelId': 'string'
}
}
},
'dynatrace': {
'envId': 'string',
'resources': [
'string',
]
},
'servicenow': {
'instanceId': 'string',
'authScopes': [
'string',
]
},
'mcpservernewrelic': {
'accountId': 'string',
'endpoint': 'string'
},
'gitlab': {
'projectId': 'string',
'projectPath': 'string',
'instanceIdentifier': 'string'
},
'eventChannel': {}
,
'azure': {
'subscriptionId': 'string'
},
'azuredevops': {
'organizationName': 'string',
'projectId': 'string',
'projectName': 'string'
},
'mcpservergrafana': {
'endpoint': 'string',
'organizationId': 'string',
'tools': [
'string',
]
},
'pagerduty': {
'services': [
'string',
],
'customerEmail': 'string'
},
'msteams': {
'teamId': 'string',
'teamName': 'string',
'transmissionTarget': {
'opsOncallTarget': {
'channelName': 'string',
'channelId': 'string'
},
'opsSRETarget': {
'channelName': 'string',
'channelId': 'string'
}
}
}
}
)
string
[REQUIRED]
The unique identifier of the AgentSpace
string
[REQUIRED]
The unique identifier of the service.
dict
[REQUIRED]
The configuration that directs how AgentSpace interacts with the given service.
sourceAws (dict) --
AWS source account configuration for monitoring resources.
accountId (string) -- [REQUIRED]
AWS Account Id corresponding to provided resources.
accountType (string) -- [REQUIRED]
Account Type 'source' for AIDevOps monitoring.
assumableRoleArn (string) -- [REQUIRED]
Role ARN to be assumed by AIDevOps to operate on behalf of customer.
externalId (string) --
External ID for additional security when assuming the role. Used to prevent the confused deputy problem.
aws (dict) --
AWS monitor account configuration.
assumableRoleArn (string) -- [REQUIRED]
Role ARN to be assumed by AIDevOps to operate on behalf of customer.
accountId (string) -- [REQUIRED]
AWS Account Id corresponding to provided resources.
accountType (string) -- [REQUIRED]
Account Type 'monitor' for AIDevOps monitoring.
github (dict) --
GitHub repository integration configuration.
repoName (string) -- [REQUIRED]
Associated Github repo name
repoId (string) -- [REQUIRED]
Associated Github repo ID
owner (string) -- [REQUIRED]
The GitHub repository owner name.
ownerType (string) -- [REQUIRED]
Type of GitHub repository owner.
instanceIdentifier (string) --
GitHub instance identifier (e.g., github.com or github.enterprise.com)
slack (dict) --
Slack workspace integration configuration.
workspaceId (string) -- [REQUIRED]
Associated Slack workspace ID
workspaceName (string) -- [REQUIRED]
Associated Slack workspace name
transmissionTarget (dict) -- [REQUIRED]
Transmission targets for agent notifications
opsOncallTarget (dict) -- [REQUIRED]
Destination for On-call Agent (Ops1)
channelName (string) --
Slack channel name
channelId (string) -- [REQUIRED]
Slack channel ID
opsSRETarget (dict) --
Destination for SRE Agent (Ops1.5)
channelName (string) --
Slack channel name
channelId (string) -- [REQUIRED]
Slack channel ID
dynatrace (dict) --
Dynatrace monitoring integration configuration.
envId (string) -- [REQUIRED]
Dynatrace environment id
resources (list) --
List of Dynatrace resources to monitor
(string) --
servicenow (dict) --
ServiceNow instance integration configuration.
instanceId (string) --
ServiceNow instance ID
authScopes (list) --
Scoped down authentication scopes for fine grained control
(string) --
mcpservernewrelic (dict) --
NewRelic instance integration configuration.
accountId (string) -- [REQUIRED]
New Relic Account ID
endpoint (string) -- [REQUIRED]
MCP server endpoint URL (e.g., https://mcp.newrelic.com/mcp/)
gitlab (dict) --
GitLab project integration configuration.
projectId (string) -- [REQUIRED]
GitLab numeric project ID.
projectPath (string) -- [REQUIRED]
Full GitLab project path (e.g., namespace/project-name).
instanceIdentifier (string) --
GitLab instance identifier (e.g., gitlab.com or e2e.gamma.dev.us-east-1.gitlab.falco.ai.aws.dev)
eventChannel (dict) --
Event Channel instance integration configuration.
azure (dict) --
Azure subscription integration configuration.
subscriptionId (string) -- [REQUIRED]
Azure subscription ID corresponding to provided resources.
azuredevops (dict) --
Azure DevOps project integration configuration.
organizationName (string) -- [REQUIRED]
Azure DevOps organization name.
projectId (string) -- [REQUIRED]
Azure DevOps project ID.
projectName (string) -- [REQUIRED]
Azure DevOps project name.
mcpservergrafana (dict) --
Grafana MCP server integration configuration.
endpoint (string) -- [REQUIRED]
Grafana instance URL (e.g., https://your-instance.grafana.net)
organizationId (string) --
The Grafana organization ID that can be used.
tools (list) --
List of MCP tools that can be used.
(string) --
pagerduty (dict) --
PagerDuty integration configuration
services (list) -- [REQUIRED]
List of Pagerduty service available for the association.
(string) --
customerEmail (string) -- [REQUIRED]
Email to be used in Pagerduty API header
msteams (dict) --
MS Teams integration configuration
teamId (string) -- [REQUIRED]
Associated MS Teams teams ID
teamName (string) -- [REQUIRED]
Associated MS Teams team name
transmissionTarget (dict) -- [REQUIRED]
Transmission targets for agent notification
opsOncallTarget (dict) --
Destination for On-call Agent(Ops1)
channelName (string) -- [REQUIRED]
MS Teams channel name
channelId (string) -- [REQUIRED]
MS Teams Channel ID
opsSRETarget (dict) --
Destination for SRE Agent (Ops1.5)
channelName (string) -- [REQUIRED]
MS Teams channel name
channelId (string) -- [REQUIRED]
MS Teams Channel ID
dict
Response Syntax
{
'association': {
'agentSpaceId': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'status': 'valid'|'invalid'|'pending-confirmation',
'associationId': 'string',
'serviceId': 'string',
'configuration': {
'sourceAws': {
'accountId': 'string',
'accountType': 'source',
'assumableRoleArn': 'string',
'externalId': 'string'
},
'aws': {
'assumableRoleArn': 'string',
'accountId': 'string',
'accountType': 'monitor'
},
'github': {
'repoName': 'string',
'repoId': 'string',
'owner': 'string',
'ownerType': 'organization'|'user',
'instanceIdentifier': 'string'
},
'slack': {
'workspaceId': 'string',
'workspaceName': 'string',
'transmissionTarget': {
'opsOncallTarget': {
'channelName': 'string',
'channelId': 'string'
},
'opsSRETarget': {
'channelName': 'string',
'channelId': 'string'
}
}
},
'dynatrace': {
'envId': 'string',
'resources': [
'string',
]
},
'servicenow': {
'instanceId': 'string',
'authScopes': [
'string',
]
},
'mcpservernewrelic': {
'accountId': 'string',
'endpoint': 'string'
},
'gitlab': {
'projectId': 'string',
'projectPath': 'string',
'instanceIdentifier': 'string'
},
'eventChannel': {},
'azure': {
'subscriptionId': 'string'
},
'azuredevops': {
'organizationName': 'string',
'projectId': 'string',
'projectName': 'string'
},
'mcpservergrafana': {
'endpoint': 'string',
'organizationId': 'string',
'tools': [
'string',
]
},
'pagerduty': {
'services': [
'string',
],
'customerEmail': 'string'
},
'msteams': {
'teamId': 'string',
'teamName': 'string',
'transmissionTarget': {
'opsOncallTarget': {
'channelName': 'string',
'channelId': 'string'
},
'opsSRETarget': {
'channelName': 'string',
'channelId': 'string'
}
}
}
}
},
'webhook': {
'webhookUrl': 'string',
'webhookId': 'string',
'webhookType': 'hmac'|'apikey'|'gitlab'|'pagerduty',
'webhookSecret': 'string',
'apiKey': 'string'
}
}
Response Structure
(dict) --
Output containing the newly created association and optional webhook configuration.
association (dict) --
Represents a service association within an AgentSpace, defining how the agent interacts with external services.
agentSpaceId (string) --
The unique identifier of the AgentSpace
createdAt (datetime) --
The timestamp when the resource was created.
updatedAt (datetime) --
The timestamp when the resource was last updated.
status (string) --
Validation status
associationId (string) --
The unique identifier of the given association.
serviceId (string) --
The identifier for associated service
configuration (dict) --
The configuration that directs how AgentSpace interacts with the given service.
sourceAws (dict) --
AWS source account configuration for monitoring resources.
accountId (string) --
AWS Account Id corresponding to provided resources.
accountType (string) --
Account Type 'source' for AIDevOps monitoring.
assumableRoleArn (string) --
Role ARN to be assumed by AIDevOps to operate on behalf of customer.
externalId (string) --
External ID for additional security when assuming the role. Used to prevent the confused deputy problem.
aws (dict) --
AWS monitor account configuration.
assumableRoleArn (string) --
Role ARN to be assumed by AIDevOps to operate on behalf of customer.
accountId (string) --
AWS Account Id corresponding to provided resources.
accountType (string) --
Account Type 'monitor' for AIDevOps monitoring.
github (dict) --
GitHub repository integration configuration.
repoName (string) --
Associated Github repo name
repoId (string) --
Associated Github repo ID
owner (string) --
The GitHub repository owner name.
ownerType (string) --
Type of GitHub repository owner.
instanceIdentifier (string) --
GitHub instance identifier (e.g., github.com or github.enterprise.com)
slack (dict) --
Slack workspace integration configuration.
workspaceId (string) --
Associated Slack workspace ID
workspaceName (string) --
Associated Slack workspace name
transmissionTarget (dict) --
Transmission targets for agent notifications
opsOncallTarget (dict) --
Destination for On-call Agent (Ops1)
channelName (string) --
Slack channel name
channelId (string) --
Slack channel ID
opsSRETarget (dict) --
Destination for SRE Agent (Ops1.5)
channelName (string) --
Slack channel name
channelId (string) --
Slack channel ID
dynatrace (dict) --
Dynatrace monitoring integration configuration.
envId (string) --
Dynatrace environment id
resources (list) --
List of Dynatrace resources to monitor
(string) --
servicenow (dict) --
ServiceNow instance integration configuration.
instanceId (string) --
ServiceNow instance ID
authScopes (list) --
Scoped down authentication scopes for fine grained control
(string) --
mcpservernewrelic (dict) --
NewRelic instance integration configuration.
accountId (string) --
New Relic Account ID
endpoint (string) --
MCP server endpoint URL (e.g., https://mcp.newrelic.com/mcp/)
gitlab (dict) --
GitLab project integration configuration.
projectId (string) --
GitLab numeric project ID.
projectPath (string) --
Full GitLab project path (e.g., namespace/project-name).
instanceIdentifier (string) --
GitLab instance identifier (e.g., gitlab.com or e2e.gamma.dev.us-east-1.gitlab.falco.ai.aws.dev)
eventChannel (dict) --
Event Channel instance integration configuration.
azure (dict) --
Azure subscription integration configuration.
subscriptionId (string) --
Azure subscription ID corresponding to provided resources.
azuredevops (dict) --
Azure DevOps project integration configuration.
organizationName (string) --
Azure DevOps organization name.
projectId (string) --
Azure DevOps project ID.
projectName (string) --
Azure DevOps project name.
mcpservergrafana (dict) --
Grafana MCP server integration configuration.
endpoint (string) --
Grafana instance URL (e.g., https://your-instance.grafana.net)
organizationId (string) --
The Grafana organization ID that can be used.
tools (list) --
List of MCP tools that can be used.
(string) --
pagerduty (dict) --
PagerDuty integration configuration
services (list) --
List of Pagerduty service available for the association.
(string) --
customerEmail (string) --
Email to be used in Pagerduty API header
msteams (dict) --
MS Teams integration configuration
teamId (string) --
Associated MS Teams teams ID
teamName (string) --
Associated MS Teams team name
transmissionTarget (dict) --
Transmission targets for agent notification
opsOncallTarget (dict) --
Destination for On-call Agent(Ops1)
channelName (string) --
MS Teams channel name
channelId (string) --
MS Teams Channel ID
opsSRETarget (dict) --
Destination for SRE Agent (Ops1.5)
channelName (string) --
MS Teams channel name
channelId (string) --
MS Teams Channel ID
webhook (dict) --
Generic webhook configuration
webhookUrl (string) --
The webhook URL endpoint
webhookId (string) --
The unique webhook identifier
webhookType (string) --
The webhook authentication type
webhookSecret (string) --
The webhook secret for authentication
apiKey (string) --
API Key for API Key webhook authentication
Initiate a chat for support case in the specified agent space
See also: AWS API Documentation
Request Syntax
client.initiate_chat_for_case(
agentSpaceId='string',
taskId='string',
clientToken='string'
)
string
[REQUIRED]
The unique identifier for the agent space containing the task
string
[REQUIRED]
The unique identifier for this task
string
Client-provided token for idempotent operations
This field is autopopulated if not provided.
dict
Response Syntax
{
'chatParticipantConnection': {
'initialContactId': 'string',
'participantId': 'string',
'participantToken': 'string'
}
}
Response Structure
(dict) --
Response structure containing the chat participant connection
chatParticipantConnection (dict) --
The newly created chat participant connection
initialContactId (string) --
The identifier of the contact in this instance of Amazon Connect
participantId (string) --
The identifier for a chat participant
participantToken (string) --
The token used by the chat participant to call CreateParticipantConnection
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'|'msteams'|'dynatrace'|'servicenow'|'pagerduty'|'gitlab'|'eventChannel'|'mcpservernewrelic'|'mcpservergrafana'|'mcpserverdatadog'|'mcpserver'|'mcpserversplunk'|'azureidentity'|'mcpserversigv4'
)
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'|'msteams'|'dynatrace'|'servicenow'|'pagerduty'|'gitlab'|'eventChannel'|'mcpservernewrelic'|'mcpservergrafana'|'mcpserverdatadog'|'mcpserver'|'mcpserversplunk'|'azureidentity'|'mcpserversigv4',
'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',
'description': 'string',
'apiKeyHeader': 'string'
},
'mcpserver': {
'name': 'string',
'endpoint': 'string',
'authorizationMethod': 'oauth-client-credentials'|'oauth-3lo'|'api-key'|'bearer-token',
'description': 'string',
'apiKeyHeader': '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',
'description': 'string',
'apiKeyHeader': 'string'
},
'mcpservernewrelic': {
'accountId': 'string',
'region': 'US'|'EU',
'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'
},
'pagerduty': {
'scopes': [
'string',
]
},
'mcpserversigv4': {
'name': 'string',
'endpoint': 'string',
'description': 'string',
'region': 'string',
'service': 'string',
'roleArn': 'string'
}
},
'kmsKeyArn': 'string',
'privateConnectionName': 'string'
},
]
}
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.
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.
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.
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.
service (string) --
AWS service name for SigV4 signing.
roleArn (string) --
IAM role ARN to assume for SigV4 signing.
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.
Creates a new chat execution in the specified agent space
See also: AWS API Documentation
Request Syntax
client.create_chat(
agentSpaceId='string',
userId='string',
userType='IAM'|'IDC'|'IDP'
)
string
[REQUIRED]
Unique identifier for an agent space (allows alphanumeric characters and hyphens; 1-64 characters)
string
[REQUIRED]
The user identifier for the chat
string
The authentication type of the user
dict
Response Syntax
{
'executionId': 'string',
'createdAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Response structure for creating a new chat
executionId (string) --
The unique identifier for the created execution
createdAt (datetime) --
Timestamp when the chat was created
Disable the Operator App for the specified AgentSpace
See also: AWS API Documentation
Request Syntax
client.disable_operator_app(
agentSpaceId='string',
authFlow='iam'|'idc'|'idp'
)
string
[REQUIRED]
The unique identifier of the AgentSpace
string
The authentication flow configured for the operator App. e.g. idc
None
Adds or overwrites tags for the specified AWS DevOps Agent resource.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The ARN of the resource to tag.
dict
[REQUIRED]
Tags to add to the resource.
(string) --
Tag key string.
(string) --
Tag value string.
dict
Response Syntax
{}
Response Structure
(dict) --
End a chat session for a support case in the specified agent space
See also: AWS API Documentation
Request Syntax
client.end_chat_for_case(
agentSpaceId='string',
taskId='string',
reason='string',
requester='string',
clientToken='string'
)
string
[REQUIRED]
The unique identifier for the agent space containing the task
string
[REQUIRED]
The unique identifier for the task execution to end
string
Reason for ending the chat session (optional, defaults to 'Chat Ended by CloudSmith')
string
Who initiated the chat end request (optional, defaults to 'CloudSmith')
string
Client-provided token for idempotent operations
This field is autopopulated if not provided.
dict
Response Syntax
{
'isDisconnected': True|False,
'executionId': 'string',
'errorMessage': 'string'
}
Response Structure
(dict) --
Response structure for end chat operation
isDisconnected (boolean) --
Whether the chat session was successfully ended
executionId (string) --
The execution ID that was ended
errorMessage (string) --
Error message if the disconnect failed
Lists all Private Connections in the caller's account.
See also: AWS API Documentation
Request Syntax
client.list_private_connections()
dict
Response Syntax
{
'privateConnections': [
{
'name': 'string',
'type': 'SELF_MANAGED'|'SERVICE_MANAGED',
'resourceGatewayId': 'string',
'hostAddress': 'string',
'vpcId': 'string',
'resourceConfigurationId': 'string',
'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED',
'certificateExpiryTime': datetime(2015, 1, 1)
},
]
}
Response Structure
(dict) --
Output containing the list of Private Connections.
privateConnections (list) --
The list of Private Connections.
(dict) --
Summary of a Private Connection.
name (string) --
The name of the Private Connection.
type (string) --
The type of the Private Connection.
resourceGatewayId (string) --
The service-managed Resource Gateway ARN. Only present for service-managed Private Connections.
hostAddress (string) --
IP address or DNS name of the target resource. Only present for service-managed Private Connections.
vpcId (string) --
VPC identifier of the service-managed Resource Gateway. Only present for service-managed Private Connections.
resourceConfigurationId (string) --
The Resource Configuration ARN. Only present for self-managed Private Connections.
status (string) --
The status of the Private Connection.
certificateExpiryTime (datetime) --
The expiry time of the certificate associated with the Private Connection. Only present when a certificate is associated.
Updates an existing recommendation with new content, status, or metadata
See also: AWS API Documentation
Request Syntax
client.update_recommendation(
agentSpaceId='string',
recommendationId='string',
status='PROPOSED'|'ACCEPTED'|'REJECTED'|'CLOSED'|'COMPLETED'|'UPDATE_IN_PROGRESS',
additionalContext='string',
clientToken='string'
)
string
[REQUIRED]
The unique identifier for the agent space containing the recommendation
string
[REQUIRED]
The unique identifier for the recommendation to update
string
Current status of the recommendation
string
Additional context for recommendation
string
A unique token that ensures idempotency of the request
This field is autopopulated if not provided.
dict
Response Syntax
{
'recommendation': {
'agentSpaceArn': 'string',
'recommendationId': 'string',
'taskId': 'string',
'goalId': 'string',
'title': 'string',
'content': {
'summary': 'string',
'spec': 'string'
},
'status': 'PROPOSED'|'ACCEPTED'|'REJECTED'|'CLOSED'|'COMPLETED'|'UPDATE_IN_PROGRESS',
'priority': 'HIGH'|'MEDIUM'|'LOW',
'goalVersion': 123,
'additionalContext': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'version': 123
}
}
Response Structure
(dict) --
Response structure containing the updated recommendation
recommendation (dict) --
The updated recommendation
agentSpaceArn (string) --
ARN of the agent space this recommendation belongs to
recommendationId (string) --
The unique identifier for this recommendation
taskId (string) --
ID of the task that generated the recommendation
goalId (string) --
ID of the goal this recommendation is associated with
title (string) --
The title of the recommendation
content (dict) --
Content of the recommendation
summary (string) --
A brief summary of the recommendation.
spec (string) --
Agent-ready specification with detailed implementation steps
status (string) --
Current status of the recommendation
priority (string) --
Priority level of the recommendation
goalVersion (integer) --
Version of the goal at the time this recommendation was generated
additionalContext (string) --
Additional context for recommendation
createdAt (datetime) --
Timestamp when this recommendation was created
updatedAt (datetime) --
Timestamp when this recommendation was last updated
version (integer) --
Version number for optimistic locking
Describe the support level of a CloudSmith customer account.
See also: AWS API Documentation
Request Syntax
client.describe_support_level(
agentSpaceId='string',
taskId='string'
)
string
[REQUIRED]
The unique identifier for the agent space containing the task
string
[REQUIRED]
The unique identifier for this task
dict
Response Syntax
{
'supportLevel': {
'code': 'string',
'name': 'string'
},
'mosaicSupportLevel': {
'code': 'string',
'name': 'string'
},
'activeSubscription': True|False
}
Response Structure
(dict) --
Response structure containing detailed support level for an account
supportLevel (dict) --
The account's support level
code (string) --
The support level code
name (string) --
The support level name
mosaicSupportLevel (dict) --
The account's Mosaic equivalent support level
code (string) --
The support level code
name (string) --
The support level name
activeSubscription (boolean) --
Whether or not the account's subscription is active
Lists tags for the specified AWS DevOps Agent resource.
See also: AWS API Documentation
Request Syntax
client.list_tags_for_resource(
resourceArn='string'
)
string
[REQUIRED]
The ARN of the resource.
dict
Response Syntax
{
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
tags (dict) --
Tags associated with the resource.
(string) --
Tag key string.
(string) --
Tag value string.
Creates a new AgentSpace with the specified name and description. Duplicate space names are allowed.
See also: AWS API Documentation
Request Syntax
client.create_agent_space(
name='string',
description='string',
locale='string',
kmsKeyArn='string',
clientToken='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
The name of the AgentSpace.
string
The description of the AgentSpace.
string
The locale for the AgentSpace, which determines the language used in agent responses.
string
The ARN of the AWS Key Management Service (AWS KMS) customer managed key that's used to encrypt resources.
string
Client-provided token to ensure request idempotency. When the same token is provided in subsequent calls, the same response is returned within a 8-hour window.
This field is autopopulated if not provided.
dict
Tags to add to the AgentSpace at creation time.
(string) --
Tag key string.
(string) --
Tag value string.
dict
Response Syntax
{
'agentSpace': {
'name': 'string',
'description': 'string',
'locale': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'kmsKeyArn': 'string',
'agentSpaceId': 'string'
},
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Output containing the newly created AgentSpace.
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
tags (dict) --
Tags associated with the created AgentSpace.
(string) --
Tag key string.
(string) --
Tag value string.
List all webhooks for given Association
See also: AWS API Documentation
Request Syntax
client.list_webhooks(
agentSpaceId='string',
associationId='string'
)
string
[REQUIRED]
The unique identifier of the AgentSpace
string
[REQUIRED]
The unique identifier of the given association.
dict
Response Syntax
{
'webhooks': [
{
'webhookUrl': 'string',
'webhookType': 'hmac'|'apikey'|'gitlab'|'pagerduty',
'webhookId': 'string'
},
]
}
Response Structure
(dict) --
Output containing a list of service association webhooks.
webhooks (list) --
The list of association webhooks.
(dict) --
Represents a complete Webhook with all its properties, and unique identifier.
webhookUrl (string) --
Webhook endpoint URL.
webhookType (string) --
Webhook authentication type.
webhookId (string) --
The unique identifier of the Webhook
Deregister a service
See also: AWS API Documentation
Request Syntax
client.deregister_service(
serviceId='string'
)
string
[REQUIRED]
The service id to deregister. A service can only be deregistered if it is not associated with any AgentSpace.
dict
Response Syntax
{}
Response Structure
(dict) --
Empty output for successful service deregistration.
Retrieves a paginated list of the user's recent chat executions
See also: AWS API Documentation
Request Syntax
client.list_chats(
agentSpaceId='string',
userId='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
Unique identifier for an agent space (allows alphanumeric characters and hyphens; 1-64 characters)
string
[REQUIRED]
The user identifier to list chats for
integer
Maximum number of results to return
string
Token for pagination
dict
Response Syntax
{
'executions': [
{
'executionId': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'summary': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Response structure for listing chats
executions (list) --
List of recent chat executions
(dict) --
A single chat execution summary
executionId (string) --
The unique identifier for the execution
createdAt (datetime) --
Timestamp when the chat was created
updatedAt (datetime) --
Timestamp when the chat was last updated
summary (string) --
Summary or title of the chat
nextToken (string) --
Token for retrieving the next page of results
Retrieves a specific recommendation by its ID
See also: AWS API Documentation
Request Syntax
client.get_recommendation(
agentSpaceId='string',
recommendationId='string',
recommendationVersion=123
)
string
[REQUIRED]
The unique identifier for the agent space containing the recommendation
string
[REQUIRED]
The unique identifier for the recommendation to retrieve
integer
Specific version of the recommendation to retrieve. If not specified, returns the latest version.
dict
Response Syntax
{
'recommendation': {
'agentSpaceArn': 'string',
'recommendationId': 'string',
'taskId': 'string',
'goalId': 'string',
'title': 'string',
'content': {
'summary': 'string',
'spec': 'string'
},
'status': 'PROPOSED'|'ACCEPTED'|'REJECTED'|'CLOSED'|'COMPLETED'|'UPDATE_IN_PROGRESS',
'priority': 'HIGH'|'MEDIUM'|'LOW',
'goalVersion': 123,
'additionalContext': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'version': 123
}
}
Response Structure
(dict) --
Response structure containing the requested recommendation
recommendation (dict) --
The requested recommendation
agentSpaceArn (string) --
ARN of the agent space this recommendation belongs to
recommendationId (string) --
The unique identifier for this recommendation
taskId (string) --
ID of the task that generated the recommendation
goalId (string) --
ID of the goal this recommendation is associated with
title (string) --
The title of the recommendation
content (dict) --
Content of the recommendation
summary (string) --
A brief summary of the recommendation.
spec (string) --
Agent-ready specification with detailed implementation steps
status (string) --
Current status of the recommendation
priority (string) --
Priority level of the recommendation
goalVersion (integer) --
Version of the goal at the time this recommendation was generated
additionalContext (string) --
Additional context for recommendation
createdAt (datetime) --
Timestamp when this recommendation was created
updatedAt (datetime) --
Timestamp when this recommendation was last updated
version (integer) --
Version number for optimistic locking
Validates an aws association and set status and returns a 204 No Content response on success.
See also: AWS API Documentation
Request Syntax
client.validate_aws_associations(
agentSpaceId='string'
)
string
[REQUIRED]
The unique identifier of the AgentSpace
dict
Response Syntax
{}
Response Structure
(dict) --
Empty Output for successful validating an aws association
Creates a new backlog task in the specified agent space
See also: AWS API Documentation
Request Syntax
client.create_backlog_task(
agentSpaceId='string',
reference={
'system': 'string',
'title': 'string',
'referenceId': 'string',
'referenceUrl': 'string',
'associationId': 'string'
},
taskType='INVESTIGATION'|'EVALUATION',
title='string',
description='string',
priority='CRITICAL'|'HIGH'|'MEDIUM'|'LOW'|'MINIMAL',
clientToken='string'
)
string
[REQUIRED]
The unique identifier for the agent space where the task will be created
dict
Optional reference information for the task
system (string) -- [REQUIRED]
The name of the external system
title (string) --
Optional title for the reference
referenceId (string) -- [REQUIRED]
The unique identifier in the external system
referenceUrl (string) -- [REQUIRED]
URL to access the reference in the external system
associationId (string) -- [REQUIRED]
Association identifier of the external system
string
[REQUIRED]
The type of task being created
string
[REQUIRED]
The title of the backlog task
string
Optional detailed description of the task
string
[REQUIRED]
The priority level of the task
string
Client-provided token for idempotent operations
This field is autopopulated if not provided.
dict
Response Syntax
{
'task': {
'agentSpaceId': 'string',
'taskId': 'string',
'executionId': 'string',
'title': 'string',
'description': 'string',
'reference': {
'system': 'string',
'title': 'string',
'referenceId': 'string',
'referenceUrl': 'string',
'associationId': 'string'
},
'taskType': 'INVESTIGATION'|'EVALUATION',
'priority': 'CRITICAL'|'HIGH'|'MEDIUM'|'LOW'|'MINIMAL',
'status': 'PENDING_TRIAGE'|'LINKED'|'PENDING_START'|'IN_PROGRESS'|'PENDING_CUSTOMER_APPROVAL'|'COMPLETED'|'FAILED'|'TIMED_OUT'|'CANCELED',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'version': 123,
'supportMetadata': {...}|[...]|123|123.4|'string'|True|None,
'metadata': {...}|[...]|123|123.4|'string'|True|None,
'primaryTaskId': 'string',
'statusReason': 'string',
'hasLinkedTasks': True|False
}
}
Response Structure
(dict) --
Response structure containing the created backlog task
task (dict) --
The newly created task object
agentSpaceId (string) --
The unique identifier for the agent space containing this task
taskId (string) --
The unique identifier for this task
executionId (string) --
The execution ID associated with this task, if any
title (string) --
The title of the task
description (string) --
Optional detailed description of the task
reference (dict) --
Optional reference information linking this task to external systems
system (string) --
The name of the external system
title (string) --
Optional title for the reference
referenceId (string) --
The unique identifier in the external system
referenceUrl (string) --
URL to access the reference in the external system
associationId (string) --
Association identifier of the external system
taskType (string) --
The type of this task
priority (string) --
The priority level of this task
status (string) --
The current status of this task
createdAt (datetime) --
Timestamp when this task was created
updatedAt (datetime) --
Timestamp when this task was last updated
version (integer) --
Version number for optimistic locking
supportMetadata (:ref:`document<document>`) --
Optional support metadata for the task
metadata (:ref:`document<document>`) --
Optional metadata for the task
primaryTaskId (string) --
The task ID of the primary investigation this task is linked to
statusReason (string) --
Explanation for why the task status was changed (e.g., linked reason)
hasLinkedTasks (boolean) --
Indicates if this task has other tasks linked to it
Creates a Private Connection to a target resource.
See also: AWS API Documentation
Request Syntax
client.create_private_connection(
name='string',
mode={
'serviceManaged': {
'hostAddress': 'string',
'vpcId': 'string',
'subnetIds': [
'string',
],
'securityGroupIds': [
'string',
],
'ipAddressType': 'IPV4'|'IPV6'|'DUAL_STACK',
'ipv4AddressesPerEni': 123,
'portRanges': [
'string',
],
'certificate': 'string'
},
'selfManaged': {
'resourceConfigurationId': 'string',
'certificate': 'string'
}
},
tags={
'string': 'string'
}
)
string
[REQUIRED]
Unique name for this Private Connection within the account.
dict
[REQUIRED]
Private Connection mode configuration.
serviceManaged (dict) --
Service manages the Resource Gateway lifecycle.
hostAddress (string) -- [REQUIRED]
IP address or DNS name of the target resource.
vpcId (string) -- [REQUIRED]
VPC to create the service-managed Resource Gateway in.
subnetIds (list) -- [REQUIRED]
Subnets that the service-managed Resource Gateway will span.
(string) --
Subnet identifier.
securityGroupIds (list) --
Security groups to attach to the service-managed Resource Gateway. If not specified, a default security group is created.
(string) --
Security group identifier.
ipAddressType (string) --
IP address type of the service-managed Resource Gateway.
ipv4AddressesPerEni (integer) --
Number of IPv4 addresses in each ENI for the service-managed Resource Gateway.
portRanges (list) --
TCP port ranges that a consumer can use to access the resource.
(string) --
TCP port range expression (single port or range e.g. '443' or '8080-8090'). Valid port values are 0-65535, enforced at runtime.
certificate (string) --
Certificate for the Private Connection.
selfManaged (dict) --
Caller manages their own resource configuration.
resourceConfigurationId (string) -- [REQUIRED]
The ARN of the Resource Configuration.
certificate (string) --
Certificate for the Private Connection.
dict
Tags to add to the Private Connection at creation time.
(string) --
Tag key string.
(string) --
Tag value string.
dict
Response Syntax
{
'name': 'string',
'type': 'SELF_MANAGED'|'SERVICE_MANAGED',
'resourceGatewayId': 'string',
'hostAddress': 'string',
'vpcId': 'string',
'resourceConfigurationId': 'string',
'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED',
'certificateExpiryTime': datetime(2015, 1, 1),
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Output containing the newly created Private Connection summary.
name (string) --
The name of the Private Connection.
type (string) --
The type of the Private Connection.
resourceGatewayId (string) --
The service-managed Resource Gateway ARN. Only present for service-managed Private Connections.
hostAddress (string) --
IP address or DNS name of the target resource. Only present for service-managed Private Connections.
vpcId (string) --
VPC identifier of the service-managed Resource Gateway. Only present for service-managed Private Connections.
resourceConfigurationId (string) --
The Resource Configuration ARN. Only present for self-managed Private Connections.
status (string) --
The status of the Private Connection.
certificateExpiryTime (datetime) --
The expiry time of the certificate associated with the Private Connection. Only present when a certificate is associated.
tags (dict) --
Tags associated with the created Private Connection.
(string) --
Tag key string.
(string) --
Tag value string.
List all associations for given AgentSpace
See also: AWS API Documentation
Request Syntax
client.list_associations(
agentSpaceId='string',
maxResults=123,
nextToken='string',
filterServiceTypes='string'
)
string
[REQUIRED]
The unique identifier of the AgentSpace
integer
Maximum number of results to return in a single call.
string
Token for the next page of results.
string
A comma-separated list of service types to filter list associations output
dict
Response Syntax
{
'nextToken': 'string',
'associations': [
{
'agentSpaceId': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'status': 'valid'|'invalid'|'pending-confirmation',
'associationId': 'string',
'serviceId': 'string',
'configuration': {
'sourceAws': {
'accountId': 'string',
'accountType': 'source',
'assumableRoleArn': 'string',
'externalId': 'string'
},
'aws': {
'assumableRoleArn': 'string',
'accountId': 'string',
'accountType': 'monitor'
},
'github': {
'repoName': 'string',
'repoId': 'string',
'owner': 'string',
'ownerType': 'organization'|'user',
'instanceIdentifier': 'string'
},
'slack': {
'workspaceId': 'string',
'workspaceName': 'string',
'transmissionTarget': {
'opsOncallTarget': {
'channelName': 'string',
'channelId': 'string'
},
'opsSRETarget': {
'channelName': 'string',
'channelId': 'string'
}
}
},
'dynatrace': {
'envId': 'string',
'resources': [
'string',
]
},
'servicenow': {
'instanceId': 'string',
'authScopes': [
'string',
]
},
'mcpservernewrelic': {
'accountId': 'string',
'endpoint': 'string'
},
'gitlab': {
'projectId': 'string',
'projectPath': 'string',
'instanceIdentifier': 'string'
},
'eventChannel': {},
'azure': {
'subscriptionId': 'string'
},
'azuredevops': {
'organizationName': 'string',
'projectId': 'string',
'projectName': 'string'
},
'mcpservergrafana': {
'endpoint': 'string',
'organizationId': 'string',
'tools': [
'string',
]
},
'pagerduty': {
'services': [
'string',
],
'customerEmail': 'string'
},
'msteams': {
'teamId': 'string',
'teamName': 'string',
'transmissionTarget': {
'opsOncallTarget': {
'channelName': 'string',
'channelId': 'string'
},
'opsSRETarget': {
'channelName': 'string',
'channelId': 'string'
}
}
}
}
},
]
}
Response Structure
(dict) --
Output containing a list of service associations and pagination token.
nextToken (string) --
Token to retrieve the next page of results, if there are more results.
associations (list) --
The list of associations.
(dict) --
Represents a service association within an AgentSpace, defining how the agent interacts with external services.
agentSpaceId (string) --
The unique identifier of the AgentSpace
createdAt (datetime) --
The timestamp when the resource was created.
updatedAt (datetime) --
The timestamp when the resource was last updated.
status (string) --
Validation status
associationId (string) --
The unique identifier of the given association.
serviceId (string) --
The identifier for associated service
configuration (dict) --
The configuration that directs how AgentSpace interacts with the given service.
sourceAws (dict) --
AWS source account configuration for monitoring resources.
accountId (string) --
AWS Account Id corresponding to provided resources.
accountType (string) --
Account Type 'source' for AIDevOps monitoring.
assumableRoleArn (string) --
Role ARN to be assumed by AIDevOps to operate on behalf of customer.
externalId (string) --
External ID for additional security when assuming the role. Used to prevent the confused deputy problem.
aws (dict) --
AWS monitor account configuration.
assumableRoleArn (string) --
Role ARN to be assumed by AIDevOps to operate on behalf of customer.
accountId (string) --
AWS Account Id corresponding to provided resources.
accountType (string) --
Account Type 'monitor' for AIDevOps monitoring.
github (dict) --
GitHub repository integration configuration.
repoName (string) --
Associated Github repo name
repoId (string) --
Associated Github repo ID
owner (string) --
The GitHub repository owner name.
ownerType (string) --
Type of GitHub repository owner.
instanceIdentifier (string) --
GitHub instance identifier (e.g., github.com or github.enterprise.com)
slack (dict) --
Slack workspace integration configuration.
workspaceId (string) --
Associated Slack workspace ID
workspaceName (string) --
Associated Slack workspace name
transmissionTarget (dict) --
Transmission targets for agent notifications
opsOncallTarget (dict) --
Destination for On-call Agent (Ops1)
channelName (string) --
Slack channel name
channelId (string) --
Slack channel ID
opsSRETarget (dict) --
Destination for SRE Agent (Ops1.5)
channelName (string) --
Slack channel name
channelId (string) --
Slack channel ID
dynatrace (dict) --
Dynatrace monitoring integration configuration.
envId (string) --
Dynatrace environment id
resources (list) --
List of Dynatrace resources to monitor
(string) --
servicenow (dict) --
ServiceNow instance integration configuration.
instanceId (string) --
ServiceNow instance ID
authScopes (list) --
Scoped down authentication scopes for fine grained control
(string) --
mcpservernewrelic (dict) --
NewRelic instance integration configuration.
accountId (string) --
New Relic Account ID
endpoint (string) --
MCP server endpoint URL (e.g., https://mcp.newrelic.com/mcp/)
gitlab (dict) --
GitLab project integration configuration.
projectId (string) --
GitLab numeric project ID.
projectPath (string) --
Full GitLab project path (e.g., namespace/project-name).
instanceIdentifier (string) --
GitLab instance identifier (e.g., gitlab.com or e2e.gamma.dev.us-east-1.gitlab.falco.ai.aws.dev)
eventChannel (dict) --
Event Channel instance integration configuration.
azure (dict) --
Azure subscription integration configuration.
subscriptionId (string) --
Azure subscription ID corresponding to provided resources.
azuredevops (dict) --
Azure DevOps project integration configuration.
organizationName (string) --
Azure DevOps organization name.
projectId (string) --
Azure DevOps project ID.
projectName (string) --
Azure DevOps project name.
mcpservergrafana (dict) --
Grafana MCP server integration configuration.
endpoint (string) --
Grafana instance URL (e.g., https://your-instance.grafana.net)
organizationId (string) --
The Grafana organization ID that can be used.
tools (list) --
List of MCP tools that can be used.
(string) --
pagerduty (dict) --
PagerDuty integration configuration
services (list) --
List of Pagerduty service available for the association.
(string) --
customerEmail (string) --
Email to be used in Pagerduty API header
msteams (dict) --
MS Teams integration configuration
teamId (string) --
Associated MS Teams teams ID
teamName (string) --
Associated MS Teams team name
transmissionTarget (dict) --
Transmission targets for agent notification
opsOncallTarget (dict) --
Destination for On-call Agent(Ops1)
channelName (string) --
MS Teams channel name
channelId (string) --
MS Teams Channel ID
opsSRETarget (dict) --
Destination for SRE Agent (Ops1.5)
channelName (string) --
MS Teams channel name
channelId (string) --
MS Teams Channel ID
Deletes a specific service association from an AgentSpace. This operation is idempotent and returns a 204 No Content response on success.
See also: AWS API Documentation
Request Syntax
client.disassociate_service(
agentSpaceId='string',
associationId='string'
)
string
[REQUIRED]
The unique identifier of the AgentSpace
string
[REQUIRED]
The unique identifier of the given association.
dict
Response Syntax
{}
Response Structure
(dict) --
Empty output for successful service disassociation.
List pending messages for a specific execution.
See also: AWS API Documentation
Request Syntax
client.list_pending_messages(
agentSpaceId='string',
executionId='string'
)
string
[REQUIRED]
Unique identifier for an agent space (allows alphanumeric characters and hyphens; 1-64 characters)
string
[REQUIRED]
The unique identifier of the execution whose journal records to retrieve
dict
Response Syntax
{
'agentSpaceId': 'string',
'executionId': 'string',
'messages': [
{
'messageId': 'string',
'message': {
'userMessage': [
{
'text': 'string',
'toolResult': {...}|[...]|123|123.4|'string'|True|None
},
],
'assistantMessage': [
{
'text': 'string',
'toolUse': {...}|[...]|123|123.4|'string'|True|None
},
]
}
},
],
'createdAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Response structure containing a list of pending messages
agentSpaceId (string) --
Unique identifier for an agent space (allows alphanumeric characters and hyphens; 1-64 characters)
executionId (string) --
The unique identifier for the execution.
messages (list) --
The list of pending messages for the execution.
(dict) --
Represents a pending message in an agent execution.
messageId (string) --
The unique identifier for this pending message.
message (dict) --
The message content.
userMessage (list) --
A message from the user.
(dict) --
A block of content in a user message.
text (string) --
Text content from the user.
toolResult (:ref:`document<document>`) --
Tool execution result provided by the user.
assistantMessage (list) --
A message from the assistant.
(dict) --
A block of content in an assistant message.
text (string) --
Text content from the assistant.
toolUse (:ref:`document<document>`) --
Tool use request from the assistant.
createdAt (datetime) --
Timestamp when the pending messages were created.
Updates the information of an existing AgentSpace.
See also: AWS API Documentation
Request Syntax
client.update_agent_space(
agentSpaceId='string',
name='string',
description='string',
locale='string'
)
string
[REQUIRED]
The unique identifier of the AgentSpace
string
The updated name of the AgentSpace.
string
The updated description of the AgentSpace.
string
The updated locale for the AgentSpace, which determines the language used in agent responses.
dict
Response Syntax
{
'agentSpace': {
'name': 'string',
'description': 'string',
'locale': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'kmsKeyArn': 'string',
'agentSpaceId': 'string'
}
}
Response Structure
(dict) --
Output containing the updated AgentSpace.
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
Updates the certificate associated with a Private Connection.
See also: AWS API Documentation
Request Syntax
client.update_private_connection_certificate(
name='string',
certificate='string'
)
string
[REQUIRED]
The name of the Private Connection.
string
[REQUIRED]
The new certificate for the Private Connection.
dict
Response Syntax
{
'name': 'string',
'type': 'SELF_MANAGED'|'SERVICE_MANAGED',
'resourceGatewayId': 'string',
'hostAddress': 'string',
'vpcId': 'string',
'resourceConfigurationId': 'string',
'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_IN_PROGRESS'|'DELETE_FAILED',
'certificateExpiryTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
Output containing the updated Private Connection summary.
name (string) --
The name of the Private Connection.
type (string) --
The type of the Private Connection.
resourceGatewayId (string) --
The service-managed Resource Gateway ARN. Only present for service-managed Private Connections.
hostAddress (string) --
IP address or DNS name of the target resource. Only present for service-managed Private Connections.
vpcId (string) --
VPC identifier of the service-managed Resource Gateway. Only present for service-managed Private Connections.
resourceConfigurationId (string) --
The Resource Configuration ARN. Only present for self-managed Private Connections.
status (string) --
The status of the Private Connection.
certificateExpiryTime (datetime) --
The expiry time of the certificate associated with the Private Connection. Only present when a certificate is associated.
Get the full auth configuration of operator including any enabled auth flow
See also: AWS API Documentation
Request Syntax
client.get_operator_app(
agentSpaceId='string'
)
string
[REQUIRED]
The unique identifier of the AgentSpace
dict
Response Syntax
{
'iam': {
'operatorAppRoleArn': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
'idc': {
'operatorAppRoleArn': 'string',
'idcInstanceArn': 'string',
'idcApplicationArn': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
'idp': {
'issuerUrl': 'string',
'clientId': 'string',
'operatorAppRoleArn': 'string',
'provider': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Output containing the Operator App configuration including authentication details.
iam (dict) --
Configuration for IAM-based authentication flow for the Operator App.
operatorAppRoleArn (string) --
The IAM role end users assume to access AIDevOps APIs
createdAt (datetime) --
The timestamp when the Operator App IAM auth flow was enabled.
updatedAt (datetime) --
The timestamp when the Operator App IAM auth flow was updated.
idc (dict) --
Configuration for AWS Identity Center (IdC) authentication flow for the Operator App.
operatorAppRoleArn (string) --
The IAM role end users assume to access AIDevOps APIs
idcInstanceArn (string) --
The IdC instance Arn used to create an IdC auth application
idcApplicationArn (string) --
The IdC application Arn created for IdC auth
createdAt (datetime) --
The timestamp when the Operator App IdC auth flow was enabled.
updatedAt (datetime) --
The timestamp when the Operator App IdC auth flow was updated.
idp (dict) --
Configuration for external Identity Provider OIDC authentication flow for the Operator App.
issuerUrl (string) --
The OIDC issuer URL of the external Identity Provider
clientId (string) --
The OIDC client ID for the IdP application
operatorAppRoleArn (string) --
The IAM role end users assume to access AIDevOps APIs
provider (string) --
The Identity Provider name (e.g., Entra, Okta, Google)
createdAt (datetime) --
The timestamp when the Operator App IdP auth flow was enabled.
updatedAt (datetime) --
The timestamp when the Operator App IdP auth flow was updated.
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'|'msteams'|'dynatrace'|'servicenow'|'pagerduty'|'gitlab'|'eventChannel'|'mcpservernewrelic'|'mcpservergrafana'|'mcpserverdatadog'|'mcpserver'|'mcpserversplunk'|'azureidentity'|'mcpserversigv4',
'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',
'description': 'string',
'apiKeyHeader': 'string'
},
'mcpserver': {
'name': 'string',
'endpoint': 'string',
'authorizationMethod': 'oauth-client-credentials'|'oauth-3lo'|'api-key'|'bearer-token',
'description': 'string',
'apiKeyHeader': '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',
'description': 'string',
'apiKeyHeader': 'string'
},
'mcpservernewrelic': {
'accountId': 'string',
'region': 'US'|'EU',
'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'
},
'pagerduty': {
'scopes': [
'string',
]
},
'mcpserversigv4': {
'name': 'string',
'endpoint': 'string',
'description': 'string',
'region': 'string',
'service': 'string',
'roleArn': 'string'
}
},
'kmsKeyArn': 'string',
'privateConnectionName': 'string'
},
'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.
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.
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.
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.
service (string) --
AWS service name for SigV4 signing.
roleArn (string) --
IAM role ARN to assume for SigV4 signing.
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.
tags (dict) --
Tags associated with the Service.
(string) --
Tag key string.
(string) --
Tag value string.
Update an existing backlog task.
See also: AWS API Documentation
Request Syntax
client.update_backlog_task(
agentSpaceId='string',
taskId='string',
taskStatus='PENDING_TRIAGE'|'LINKED'|'PENDING_START'|'IN_PROGRESS'|'PENDING_CUSTOMER_APPROVAL'|'COMPLETED'|'FAILED'|'TIMED_OUT'|'CANCELED',
clientToken='string'
)
string
[REQUIRED]
The unique identifier for the agent space containing the task
string
[REQUIRED]
The unique identifier of the task to update
string
Updated task status
string
Client-provided token for idempotent operations
This field is autopopulated if not provided.
dict
Response Syntax
{
'task': {
'agentSpaceId': 'string',
'taskId': 'string',
'executionId': 'string',
'title': 'string',
'description': 'string',
'reference': {
'system': 'string',
'title': 'string',
'referenceId': 'string',
'referenceUrl': 'string',
'associationId': 'string'
},
'taskType': 'INVESTIGATION'|'EVALUATION',
'priority': 'CRITICAL'|'HIGH'|'MEDIUM'|'LOW'|'MINIMAL',
'status': 'PENDING_TRIAGE'|'LINKED'|'PENDING_START'|'IN_PROGRESS'|'PENDING_CUSTOMER_APPROVAL'|'COMPLETED'|'FAILED'|'TIMED_OUT'|'CANCELED',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'version': 123,
'supportMetadata': {...}|[...]|123|123.4|'string'|True|None,
'metadata': {...}|[...]|123|123.4|'string'|True|None,
'primaryTaskId': 'string',
'statusReason': 'string',
'hasLinkedTasks': True|False
}
}
Response Structure
(dict) --
Response structure containing the updated task
task (dict) --
The updated task object
agentSpaceId (string) --
The unique identifier for the agent space containing this task
taskId (string) --
The unique identifier for this task
executionId (string) --
The execution ID associated with this task, if any
title (string) --
The title of the task
description (string) --
Optional detailed description of the task
reference (dict) --
Optional reference information linking this task to external systems
system (string) --
The name of the external system
title (string) --
Optional title for the reference
referenceId (string) --
The unique identifier in the external system
referenceUrl (string) --
URL to access the reference in the external system
associationId (string) --
Association identifier of the external system
taskType (string) --
The type of this task
priority (string) --
The priority level of this task
status (string) --
The current status of this task
createdAt (datetime) --
Timestamp when this task was created
updatedAt (datetime) --
Timestamp when this task was last updated
version (integer) --
Version number for optimistic locking
supportMetadata (:ref:`document<document>`) --
Optional support metadata for the task
metadata (:ref:`document<document>`) --
Optional metadata for the task
primaryTaskId (string) --
The task ID of the primary investigation this task is linked to
statusReason (string) --
Explanation for why the task status was changed (e.g., linked reason)
hasLinkedTasks (boolean) --
Indicates if this task has other tasks linked to it
Enable the Operator App to access the given AgentSpace
See also: AWS API Documentation
Request Syntax
client.enable_operator_app(
agentSpaceId='string',
authFlow='iam'|'idc'|'idp',
operatorAppRoleArn='string',
idcInstanceArn='string',
issuerUrl='string',
idpClientId='string',
idpClientSecret='string',
provider='string'
)
string
[REQUIRED]
The unique identifier of the AgentSpace
string
[REQUIRED]
The authentication flow configured for the operator App. e.g. iam or idc
string
[REQUIRED]
The IAM role end users assume to access AIDevOps APIs
string
The IdC instance Arn used to create an IdC auth application
string
The OIDC issuer URL of the external Identity Provider
string
The OIDC client ID for the IdP application
string
The OIDC client secret for the IdP application
string
The Identity Provider name (e.g., Entra, Okta, Google)
dict
Response Syntax
{
'agentSpaceId': 'string',
'iam': {
'operatorAppRoleArn': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
'idc': {
'operatorAppRoleArn': 'string',
'idcInstanceArn': 'string',
'idcApplicationArn': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
'idp': {
'issuerUrl': 'string',
'clientId': 'string',
'operatorAppRoleArn': 'string',
'provider': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Output containing the enabled Operator App configuration.
agentSpaceId (string) --
The unique identifier of the AgentSpace
iam (dict) --
Configuration for IAM-based authentication flow for the Operator App.
operatorAppRoleArn (string) --
The IAM role end users assume to access AIDevOps APIs
createdAt (datetime) --
The timestamp when the Operator App IAM auth flow was enabled.
updatedAt (datetime) --
The timestamp when the Operator App IAM auth flow was updated.
idc (dict) --
Configuration for AWS Identity Center (IdC) authentication flow for the Operator App.
operatorAppRoleArn (string) --
The IAM role end users assume to access AIDevOps APIs
idcInstanceArn (string) --
The IdC instance Arn used to create an IdC auth application
idcApplicationArn (string) --
The IdC application Arn created for IdC auth
createdAt (datetime) --
The timestamp when the Operator App IdC auth flow was enabled.
updatedAt (datetime) --
The timestamp when the Operator App IdC auth flow was updated.
idp (dict) --
Configuration for external Identity Provider OIDC authentication flow for the Operator App.
issuerUrl (string) --
The OIDC issuer URL of the external Identity Provider
clientId (string) --
The OIDC client ID for the IdP application
operatorAppRoleArn (string) --
The IAM role end users assume to access AIDevOps APIs
provider (string) --
The Identity Provider name (e.g., Entra, Okta, Google)
createdAt (datetime) --
The timestamp when the Operator App IdP auth flow was enabled.
updatedAt (datetime) --
The timestamp when the Operator App IdP auth flow was updated.
Deletes an AgentSpace. This operation is idempotent and returns a 204 No Content response on success.
See also: AWS API Documentation
Request Syntax
client.delete_agent_space(
agentSpaceId='string'
)
string
[REQUIRED]
The unique identifier of the AgentSpace
dict
Response Syntax
{}
Response Structure
(dict) --
Empty output for successful AgentSpace deletion.
List executions
See also: AWS API Documentation
Request Syntax
client.list_executions(
agentSpaceId='string',
taskId='string',
limit=123,
nextToken='string'
)
string
[REQUIRED]
The unique identifier for the agent space
string
[REQUIRED]
The unique identifier of the task whose executions to retrieve
integer
Maximum number of executions to return
string
Token for pagination to retrieve the next set of results
dict
Response Syntax
{
'executions': [
{
'agentSpaceId': 'string',
'executionId': 'string',
'parentExecutionId': 'string',
'agentSubTask': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'executionStatus': 'FAILED'|'RUNNING'|'STOPPED'|'CANCELED'|'TIMED_OUT',
'agentType': 'string',
'uid': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Response structure containing executions
executions (list) --
List of executions
(dict) --
Represents an execution instance with its lifecycle information
agentSpaceId (string) --
The unique identifier for the agent space containing this execution
executionId (string) --
The unique identifier for this execution
parentExecutionId (string) --
The identifier of the parent execution, if this is a child execution
agentSubTask (string) --
The specific subtask being executed by the agent
createdAt (datetime) --
Timestamp when this execution was created
updatedAt (datetime) --
Timestamp when this execution was last updated
executionStatus (string) --
The current status of this execution
agentType (string) --
The type of agent that performed this execution.
uid (string) --
The unique identifier for the user session associated with this execution
nextToken (string) --
Token for retrieving the next page of results, if available
Retrieves detailed information about a specific AgentSpace.
See also: AWS API Documentation
Request Syntax
client.get_agent_space(
agentSpaceId='string'
)
string
[REQUIRED]
The unique identifier of the AgentSpace
dict
Response Syntax
{
'agentSpace': {
'name': 'string',
'description': 'string',
'locale': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'kmsKeyArn': 'string',
'agentSpaceId': 'string'
},
'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
tags (dict) --
Tags associated with the AgentSpace.
(string) --
Tag key string.
(string) --
Tag value string.
Retrieves given associations configured for a specific AgentSpace.
See also: AWS API Documentation
Request Syntax
client.get_association(
agentSpaceId='string',
associationId='string'
)
string
[REQUIRED]
The unique identifier of the AgentSpace
string
[REQUIRED]
The unique identifier of the given association.
dict
Response Syntax
{
'association': {
'agentSpaceId': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'status': 'valid'|'invalid'|'pending-confirmation',
'associationId': 'string',
'serviceId': 'string',
'configuration': {
'sourceAws': {
'accountId': 'string',
'accountType': 'source',
'assumableRoleArn': 'string',
'externalId': 'string'
},
'aws': {
'assumableRoleArn': 'string',
'accountId': 'string',
'accountType': 'monitor'
},
'github': {
'repoName': 'string',
'repoId': 'string',
'owner': 'string',
'ownerType': 'organization'|'user',
'instanceIdentifier': 'string'
},
'slack': {
'workspaceId': 'string',
'workspaceName': 'string',
'transmissionTarget': {
'opsOncallTarget': {
'channelName': 'string',
'channelId': 'string'
},
'opsSRETarget': {
'channelName': 'string',
'channelId': 'string'
}
}
},
'dynatrace': {
'envId': 'string',
'resources': [
'string',
]
},
'servicenow': {
'instanceId': 'string',
'authScopes': [
'string',
]
},
'mcpservernewrelic': {
'accountId': 'string',
'endpoint': 'string'
},
'gitlab': {
'projectId': 'string',
'projectPath': 'string',
'instanceIdentifier': 'string'
},
'eventChannel': {},
'azure': {
'subscriptionId': 'string'
},
'azuredevops': {
'organizationName': 'string',
'projectId': 'string',
'projectName': 'string'
},
'mcpservergrafana': {
'endpoint': 'string',
'organizationId': 'string',
'tools': [
'string',
]
},
'pagerduty': {
'services': [
'string',
],
'customerEmail': 'string'
},
'msteams': {
'teamId': 'string',
'teamName': 'string',
'transmissionTarget': {
'opsOncallTarget': {
'channelName': 'string',
'channelId': 'string'
},
'opsSRETarget': {
'channelName': 'string',
'channelId': 'string'
}
}
}
}
}
}
Response Structure
(dict) --
Output containing the requested association details.
association (dict) --
Represents a service association within an AgentSpace, defining how the agent interacts with external services.
agentSpaceId (string) --
The unique identifier of the AgentSpace
createdAt (datetime) --
The timestamp when the resource was created.
updatedAt (datetime) --
The timestamp when the resource was last updated.
status (string) --
Validation status
associationId (string) --
The unique identifier of the given association.
serviceId (string) --
The identifier for associated service
configuration (dict) --
The configuration that directs how AgentSpace interacts with the given service.
sourceAws (dict) --
AWS source account configuration for monitoring resources.
accountId (string) --
AWS Account Id corresponding to provided resources.
accountType (string) --
Account Type 'source' for AIDevOps monitoring.
assumableRoleArn (string) --
Role ARN to be assumed by AIDevOps to operate on behalf of customer.
externalId (string) --
External ID for additional security when assuming the role. Used to prevent the confused deputy problem.
aws (dict) --
AWS monitor account configuration.
assumableRoleArn (string) --
Role ARN to be assumed by AIDevOps to operate on behalf of customer.
accountId (string) --
AWS Account Id corresponding to provided resources.
accountType (string) --
Account Type 'monitor' for AIDevOps monitoring.
github (dict) --
GitHub repository integration configuration.
repoName (string) --
Associated Github repo name
repoId (string) --
Associated Github repo ID
owner (string) --
The GitHub repository owner name.
ownerType (string) --
Type of GitHub repository owner.
instanceIdentifier (string) --
GitHub instance identifier (e.g., github.com or github.enterprise.com)
slack (dict) --
Slack workspace integration configuration.
workspaceId (string) --
Associated Slack workspace ID
workspaceName (string) --
Associated Slack workspace name
transmissionTarget (dict) --
Transmission targets for agent notifications
opsOncallTarget (dict) --
Destination for On-call Agent (Ops1)
channelName (string) --
Slack channel name
channelId (string) --
Slack channel ID
opsSRETarget (dict) --
Destination for SRE Agent (Ops1.5)
channelName (string) --
Slack channel name
channelId (string) --
Slack channel ID
dynatrace (dict) --
Dynatrace monitoring integration configuration.
envId (string) --
Dynatrace environment id
resources (list) --
List of Dynatrace resources to monitor
(string) --
servicenow (dict) --
ServiceNow instance integration configuration.
instanceId (string) --
ServiceNow instance ID
authScopes (list) --
Scoped down authentication scopes for fine grained control
(string) --
mcpservernewrelic (dict) --
NewRelic instance integration configuration.
accountId (string) --
New Relic Account ID
endpoint (string) --
MCP server endpoint URL (e.g., https://mcp.newrelic.com/mcp/)
gitlab (dict) --
GitLab project integration configuration.
projectId (string) --
GitLab numeric project ID.
projectPath (string) --
Full GitLab project path (e.g., namespace/project-name).
instanceIdentifier (string) --
GitLab instance identifier (e.g., gitlab.com or e2e.gamma.dev.us-east-1.gitlab.falco.ai.aws.dev)
eventChannel (dict) --
Event Channel instance integration configuration.
azure (dict) --
Azure subscription integration configuration.
subscriptionId (string) --
Azure subscription ID corresponding to provided resources.
azuredevops (dict) --
Azure DevOps project integration configuration.
organizationName (string) --
Azure DevOps organization name.
projectId (string) --
Azure DevOps project ID.
projectName (string) --
Azure DevOps project name.
mcpservergrafana (dict) --
Grafana MCP server integration configuration.
endpoint (string) --
Grafana instance URL (e.g., https://your-instance.grafana.net)
organizationId (string) --
The Grafana organization ID that can be used.
tools (list) --
List of MCP tools that can be used.
(string) --
pagerduty (dict) --
PagerDuty integration configuration
services (list) --
List of Pagerduty service available for the association.
(string) --
customerEmail (string) --
Email to be used in Pagerduty API header
msteams (dict) --
MS Teams integration configuration
teamId (string) --
Associated MS Teams teams ID
teamName (string) --
Associated MS Teams team name
transmissionTarget (dict) --
Transmission targets for agent notification
opsOncallTarget (dict) --
Destination for On-call Agent(Ops1)
channelName (string) --
MS Teams channel name
channelId (string) --
MS Teams Channel ID
opsSRETarget (dict) --
Destination for SRE Agent (Ops1.5)
channelName (string) --
MS Teams channel name
channelId (string) --
MS Teams Channel ID
Gets a backlog task for the specified agent space and task id
See also: AWS API Documentation
Request Syntax
client.get_backlog_task(
agentSpaceId='string',
taskId='string'
)
string
[REQUIRED]
The unique identifier for the agent space containing the task
string
[REQUIRED]
The unique identifier of the task to retrieve
dict
Response Syntax
{
'task': {
'agentSpaceId': 'string',
'taskId': 'string',
'executionId': 'string',
'title': 'string',
'description': 'string',
'reference': {
'system': 'string',
'title': 'string',
'referenceId': 'string',
'referenceUrl': 'string',
'associationId': 'string'
},
'taskType': 'INVESTIGATION'|'EVALUATION',
'priority': 'CRITICAL'|'HIGH'|'MEDIUM'|'LOW'|'MINIMAL',
'status': 'PENDING_TRIAGE'|'LINKED'|'PENDING_START'|'IN_PROGRESS'|'PENDING_CUSTOMER_APPROVAL'|'COMPLETED'|'FAILED'|'TIMED_OUT'|'CANCELED',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'version': 123,
'supportMetadata': {...}|[...]|123|123.4|'string'|True|None,
'metadata': {...}|[...]|123|123.4|'string'|True|None,
'primaryTaskId': 'string',
'statusReason': 'string',
'hasLinkedTasks': True|False
}
}
Response Structure
(dict) --
Response structure containing the requested backlog task
task (dict) --
The requested task object
agentSpaceId (string) --
The unique identifier for the agent space containing this task
taskId (string) --
The unique identifier for this task
executionId (string) --
The execution ID associated with this task, if any
title (string) --
The title of the task
description (string) --
Optional detailed description of the task
reference (dict) --
Optional reference information linking this task to external systems
system (string) --
The name of the external system
title (string) --
Optional title for the reference
referenceId (string) --
The unique identifier in the external system
referenceUrl (string) --
URL to access the reference in the external system
associationId (string) --
Association identifier of the external system
taskType (string) --
The type of this task
priority (string) --
The priority level of this task
status (string) --
The current status of this task
createdAt (datetime) --
Timestamp when this task was created
updatedAt (datetime) --
Timestamp when this task was last updated
version (integer) --
Version number for optimistic locking
supportMetadata (:ref:`document<document>`) --
Optional support metadata for the task
metadata (:ref:`document<document>`) --
Optional metadata for the task
primaryTaskId (string) --
The task ID of the primary investigation this task is linked to
statusReason (string) --
Explanation for why the task status was changed (e.g., linked reason)
hasLinkedTasks (boolean) --
Indicates if this task has other tasks linked to it
Lists recommendations for the specified agent space
See also: AWS API Documentation
Request Syntax
client.list_recommendations(
agentSpaceId='string',
taskId='string',
goalId='string',
status='PROPOSED'|'ACCEPTED'|'REJECTED'|'CLOSED'|'COMPLETED'|'UPDATE_IN_PROGRESS',
priority='HIGH'|'MEDIUM'|'LOW',
limit=123,
nextToken='string'
)
string
[REQUIRED]
The unique identifier for the agent space containing the recommendations
string
Optional task ID to filter recommendations by specific task
string
Optional goal ID to filter recommendations by specific goal
string
Optional status to filter recommendations by their current status
string
Optional priority to filter recommendations by priority level
integer
Maximum number of recommendations to return in a single response
string
Token for retrieving the next page of results
dict
Response Syntax
{
'recommendations': [
{
'agentSpaceArn': 'string',
'recommendationId': 'string',
'taskId': 'string',
'goalId': 'string',
'title': 'string',
'content': {
'summary': 'string',
'spec': 'string'
},
'status': 'PROPOSED'|'ACCEPTED'|'REJECTED'|'CLOSED'|'COMPLETED'|'UPDATE_IN_PROGRESS',
'priority': 'HIGH'|'MEDIUM'|'LOW',
'goalVersion': 123,
'additionalContext': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'version': 123
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Response structure containing a list of recommendations
recommendations (list) --
List of recommendations matching the request criteria
(dict) --
Represents a recommendation with all its properties and metadata
agentSpaceArn (string) --
ARN of the agent space this recommendation belongs to
recommendationId (string) --
The unique identifier for this recommendation
taskId (string) --
ID of the task that generated the recommendation
goalId (string) --
ID of the goal this recommendation is associated with
title (string) --
The title of the recommendation
content (dict) --
Content of the recommendation
summary (string) --
A brief summary of the recommendation.
spec (string) --
Agent-ready specification with detailed implementation steps
status (string) --
Current status of the recommendation
priority (string) --
Priority level of the recommendation
goalVersion (integer) --
Version of the goal at the time this recommendation was generated
additionalContext (string) --
Additional context for recommendation
createdAt (datetime) --
Timestamp when this recommendation was created
updatedAt (datetime) --
Timestamp when this recommendation was last updated
version (integer) --
Version number for optimistic locking
nextToken (string) --
Token for retrieving the next page of results, if more results are available
Partially updates the configuration of an existing service association for an AgentSpace. Present fields are fully replaced; absent fields are left unchanged. Returns 200 OK on success.
See also: AWS API Documentation
Request Syntax
client.update_association(
agentSpaceId='string',
associationId='string',
configuration={
'sourceAws': {
'accountId': 'string',
'accountType': 'source',
'assumableRoleArn': 'string',
'externalId': 'string'
},
'aws': {
'assumableRoleArn': 'string',
'accountId': 'string',
'accountType': 'monitor'
},
'github': {
'repoName': 'string',
'repoId': 'string',
'owner': 'string',
'ownerType': 'organization'|'user',
'instanceIdentifier': 'string'
},
'slack': {
'workspaceId': 'string',
'workspaceName': 'string',
'transmissionTarget': {
'opsOncallTarget': {
'channelName': 'string',
'channelId': 'string'
},
'opsSRETarget': {
'channelName': 'string',
'channelId': 'string'
}
}
},
'dynatrace': {
'envId': 'string',
'resources': [
'string',
]
},
'servicenow': {
'instanceId': 'string',
'authScopes': [
'string',
]
},
'mcpservernewrelic': {
'accountId': 'string',
'endpoint': 'string'
},
'gitlab': {
'projectId': 'string',
'projectPath': 'string',
'instanceIdentifier': 'string'
},
'eventChannel': {}
,
'azure': {
'subscriptionId': 'string'
},
'azuredevops': {
'organizationName': 'string',
'projectId': 'string',
'projectName': 'string'
},
'mcpservergrafana': {
'endpoint': 'string',
'organizationId': 'string',
'tools': [
'string',
]
},
'pagerduty': {
'services': [
'string',
],
'customerEmail': 'string'
},
'msteams': {
'teamId': 'string',
'teamName': 'string',
'transmissionTarget': {
'opsOncallTarget': {
'channelName': 'string',
'channelId': 'string'
},
'opsSRETarget': {
'channelName': 'string',
'channelId': 'string'
}
}
}
}
)
string
[REQUIRED]
The unique identifier of the AgentSpace
string
[REQUIRED]
The unique identifier of the given association.
dict
[REQUIRED]
The configuration that directs how AgentSpace interacts with the given service. The entire configuration is replaced on update.
sourceAws (dict) --
AWS source account configuration for monitoring resources.
accountId (string) -- [REQUIRED]
AWS Account Id corresponding to provided resources.
accountType (string) -- [REQUIRED]
Account Type 'source' for AIDevOps monitoring.
assumableRoleArn (string) -- [REQUIRED]
Role ARN to be assumed by AIDevOps to operate on behalf of customer.
externalId (string) --
External ID for additional security when assuming the role. Used to prevent the confused deputy problem.
aws (dict) --
AWS monitor account configuration.
assumableRoleArn (string) -- [REQUIRED]
Role ARN to be assumed by AIDevOps to operate on behalf of customer.
accountId (string) -- [REQUIRED]
AWS Account Id corresponding to provided resources.
accountType (string) -- [REQUIRED]
Account Type 'monitor' for AIDevOps monitoring.
github (dict) --
GitHub repository integration configuration.
repoName (string) -- [REQUIRED]
Associated Github repo name
repoId (string) -- [REQUIRED]
Associated Github repo ID
owner (string) -- [REQUIRED]
The GitHub repository owner name.
ownerType (string) -- [REQUIRED]
Type of GitHub repository owner.
instanceIdentifier (string) --
GitHub instance identifier (e.g., github.com or github.enterprise.com)
slack (dict) --
Slack workspace integration configuration.
workspaceId (string) -- [REQUIRED]
Associated Slack workspace ID
workspaceName (string) -- [REQUIRED]
Associated Slack workspace name
transmissionTarget (dict) -- [REQUIRED]
Transmission targets for agent notifications
opsOncallTarget (dict) -- [REQUIRED]
Destination for On-call Agent (Ops1)
channelName (string) --
Slack channel name
channelId (string) -- [REQUIRED]
Slack channel ID
opsSRETarget (dict) --
Destination for SRE Agent (Ops1.5)
channelName (string) --
Slack channel name
channelId (string) -- [REQUIRED]
Slack channel ID
dynatrace (dict) --
Dynatrace monitoring integration configuration.
envId (string) -- [REQUIRED]
Dynatrace environment id
resources (list) --
List of Dynatrace resources to monitor
(string) --
servicenow (dict) --
ServiceNow instance integration configuration.
instanceId (string) --
ServiceNow instance ID
authScopes (list) --
Scoped down authentication scopes for fine grained control
(string) --
mcpservernewrelic (dict) --
NewRelic instance integration configuration.
accountId (string) -- [REQUIRED]
New Relic Account ID
endpoint (string) -- [REQUIRED]
MCP server endpoint URL (e.g., https://mcp.newrelic.com/mcp/)
gitlab (dict) --
GitLab project integration configuration.
projectId (string) -- [REQUIRED]
GitLab numeric project ID.
projectPath (string) -- [REQUIRED]
Full GitLab project path (e.g., namespace/project-name).
instanceIdentifier (string) --
GitLab instance identifier (e.g., gitlab.com or e2e.gamma.dev.us-east-1.gitlab.falco.ai.aws.dev)
eventChannel (dict) --
Event Channel instance integration configuration.
azure (dict) --
Azure subscription integration configuration.
subscriptionId (string) -- [REQUIRED]
Azure subscription ID corresponding to provided resources.
azuredevops (dict) --
Azure DevOps project integration configuration.
organizationName (string) -- [REQUIRED]
Azure DevOps organization name.
projectId (string) -- [REQUIRED]
Azure DevOps project ID.
projectName (string) -- [REQUIRED]
Azure DevOps project name.
mcpservergrafana (dict) --
Grafana MCP server integration configuration.
endpoint (string) -- [REQUIRED]
Grafana instance URL (e.g., https://your-instance.grafana.net)
organizationId (string) --
The Grafana organization ID that can be used.
tools (list) --
List of MCP tools that can be used.
(string) --
pagerduty (dict) --
PagerDuty integration configuration
services (list) -- [REQUIRED]
List of Pagerduty service available for the association.
(string) --
customerEmail (string) -- [REQUIRED]
Email to be used in Pagerduty API header
msteams (dict) --
MS Teams integration configuration
teamId (string) -- [REQUIRED]
Associated MS Teams teams ID
teamName (string) -- [REQUIRED]
Associated MS Teams team name
transmissionTarget (dict) -- [REQUIRED]
Transmission targets for agent notification
opsOncallTarget (dict) --
Destination for On-call Agent(Ops1)
channelName (string) -- [REQUIRED]
MS Teams channel name
channelId (string) -- [REQUIRED]
MS Teams Channel ID
opsSRETarget (dict) --
Destination for SRE Agent (Ops1.5)
channelName (string) -- [REQUIRED]
MS Teams channel name
channelId (string) -- [REQUIRED]
MS Teams Channel ID
dict
Response Syntax
{
'association': {
'agentSpaceId': 'string',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'status': 'valid'|'invalid'|'pending-confirmation',
'associationId': 'string',
'serviceId': 'string',
'configuration': {
'sourceAws': {
'accountId': 'string',
'accountType': 'source',
'assumableRoleArn': 'string',
'externalId': 'string'
},
'aws': {
'assumableRoleArn': 'string',
'accountId': 'string',
'accountType': 'monitor'
},
'github': {
'repoName': 'string',
'repoId': 'string',
'owner': 'string',
'ownerType': 'organization'|'user',
'instanceIdentifier': 'string'
},
'slack': {
'workspaceId': 'string',
'workspaceName': 'string',
'transmissionTarget': {
'opsOncallTarget': {
'channelName': 'string',
'channelId': 'string'
},
'opsSRETarget': {
'channelName': 'string',
'channelId': 'string'
}
}
},
'dynatrace': {
'envId': 'string',
'resources': [
'string',
]
},
'servicenow': {
'instanceId': 'string',
'authScopes': [
'string',
]
},
'mcpservernewrelic': {
'accountId': 'string',
'endpoint': 'string'
},
'gitlab': {
'projectId': 'string',
'projectPath': 'string',
'instanceIdentifier': 'string'
},
'eventChannel': {},
'azure': {
'subscriptionId': 'string'
},
'azuredevops': {
'organizationName': 'string',
'projectId': 'string',
'projectName': 'string'
},
'mcpservergrafana': {
'endpoint': 'string',
'organizationId': 'string',
'tools': [
'string',
]
},
'pagerduty': {
'services': [
'string',
],
'customerEmail': 'string'
},
'msteams': {
'teamId': 'string',
'teamName': 'string',
'transmissionTarget': {
'opsOncallTarget': {
'channelName': 'string',
'channelId': 'string'
},
'opsSRETarget': {
'channelName': 'string',
'channelId': 'string'
}
}
}
}
},
'webhook': {
'webhookUrl': 'string',
'webhookId': 'string',
'webhookType': 'hmac'|'apikey'|'gitlab'|'pagerduty',
'webhookSecret': 'string',
'apiKey': 'string'
}
}
Response Structure
(dict) --
Output containing the updated association and optional webhook configuration.
association (dict) --
Represents a service association within an AgentSpace, defining how the agent interacts with external services.
agentSpaceId (string) --
The unique identifier of the AgentSpace
createdAt (datetime) --
The timestamp when the resource was created.
updatedAt (datetime) --
The timestamp when the resource was last updated.
status (string) --
Validation status
associationId (string) --
The unique identifier of the given association.
serviceId (string) --
The identifier for associated service
configuration (dict) --
The configuration that directs how AgentSpace interacts with the given service.
sourceAws (dict) --
AWS source account configuration for monitoring resources.
accountId (string) --
AWS Account Id corresponding to provided resources.
accountType (string) --
Account Type 'source' for AIDevOps monitoring.
assumableRoleArn (string) --
Role ARN to be assumed by AIDevOps to operate on behalf of customer.
externalId (string) --
External ID for additional security when assuming the role. Used to prevent the confused deputy problem.
aws (dict) --
AWS monitor account configuration.
assumableRoleArn (string) --
Role ARN to be assumed by AIDevOps to operate on behalf of customer.
accountId (string) --
AWS Account Id corresponding to provided resources.
accountType (string) --
Account Type 'monitor' for AIDevOps monitoring.
github (dict) --
GitHub repository integration configuration.
repoName (string) --
Associated Github repo name
repoId (string) --
Associated Github repo ID
owner (string) --
The GitHub repository owner name.
ownerType (string) --
Type of GitHub repository owner.
instanceIdentifier (string) --
GitHub instance identifier (e.g., github.com or github.enterprise.com)
slack (dict) --
Slack workspace integration configuration.
workspaceId (string) --
Associated Slack workspace ID
workspaceName (string) --
Associated Slack workspace name
transmissionTarget (dict) --
Transmission targets for agent notifications
opsOncallTarget (dict) --
Destination for On-call Agent (Ops1)
channelName (string) --
Slack channel name
channelId (string) --
Slack channel ID
opsSRETarget (dict) --
Destination for SRE Agent (Ops1.5)
channelName (string) --
Slack channel name
channelId (string) --
Slack channel ID
dynatrace (dict) --
Dynatrace monitoring integration configuration.
envId (string) --
Dynatrace environment id
resources (list) --
List of Dynatrace resources to monitor
(string) --
servicenow (dict) --
ServiceNow instance integration configuration.
instanceId (string) --
ServiceNow instance ID
authScopes (list) --
Scoped down authentication scopes for fine grained control
(string) --
mcpservernewrelic (dict) --
NewRelic instance integration configuration.
accountId (string) --
New Relic Account ID
endpoint (string) --
MCP server endpoint URL (e.g., https://mcp.newrelic.com/mcp/)
gitlab (dict) --
GitLab project integration configuration.
projectId (string) --
GitLab numeric project ID.
projectPath (string) --
Full GitLab project path (e.g., namespace/project-name).
instanceIdentifier (string) --
GitLab instance identifier (e.g., gitlab.com or e2e.gamma.dev.us-east-1.gitlab.falco.ai.aws.dev)
eventChannel (dict) --
Event Channel instance integration configuration.
azure (dict) --
Azure subscription integration configuration.
subscriptionId (string) --
Azure subscription ID corresponding to provided resources.
azuredevops (dict) --
Azure DevOps project integration configuration.
organizationName (string) --
Azure DevOps organization name.
projectId (string) --
Azure DevOps project ID.
projectName (string) --
Azure DevOps project name.
mcpservergrafana (dict) --
Grafana MCP server integration configuration.
endpoint (string) --
Grafana instance URL (e.g., https://your-instance.grafana.net)
organizationId (string) --
The Grafana organization ID that can be used.
tools (list) --
List of MCP tools that can be used.
(string) --
pagerduty (dict) --
PagerDuty integration configuration
services (list) --
List of Pagerduty service available for the association.
(string) --
customerEmail (string) --
Email to be used in Pagerduty API header
msteams (dict) --
MS Teams integration configuration
teamId (string) --
Associated MS Teams teams ID
teamName (string) --
Associated MS Teams team name
transmissionTarget (dict) --
Transmission targets for agent notification
opsOncallTarget (dict) --
Destination for On-call Agent(Ops1)
channelName (string) --
MS Teams channel name
channelId (string) --
MS Teams Channel ID
opsSRETarget (dict) --
Destination for SRE Agent (Ops1.5)
channelName (string) --
MS Teams channel name
channelId (string) --
MS Teams Channel ID
webhook (dict) --
Generic webhook configuration
webhookUrl (string) --
The webhook URL endpoint
webhookId (string) --
The unique webhook identifier
webhookType (string) --
The webhook authentication type
webhookSecret (string) --
The webhook secret for authentication
apiKey (string) --
API Key for API Key webhook authentication
Authorize Ingestion Hub subscription operation. Looks to see if the derived accountId from FAS has an AgentSpace.
See also: AWS API Documentation
Request Syntax
client.allow_vended_log_delivery_for_resource(
resourceArnBeingAuthorized='string',
deliverySourceArn='string',
logType='string'
)
string
[REQUIRED]
The ARN of the resource being authorized for vended log delivery.
string
[REQUIRED]
The ARN of the delivery source for vended log delivery.
string
The type of log to be delivered.
dict
Response Syntax
{
'message': 'string'
}
Response Structure
(dict) --
Output for the vended log delivery authorization operation.
message (string) --
A message describing the result of the authorization operation.
Update an existing goal
See also: AWS API Documentation
Request Syntax
client.update_goal(
agentSpaceId='string',
goalId='string',
evaluationSchedule={
'state': 'ENABLED'|'DISABLED'
},
clientToken='string'
)
string
[REQUIRED]
The unique identifier for the agent space containing the goal
string
[REQUIRED]
The unique identifier of the goal to update
dict
Update goal schedule state
state (string) -- [REQUIRED]
Whether the schedule is enabled or disabled
string
Client-provided token for idempotent operations
This field is autopopulated if not provided.
dict
Response Syntax
{
'goal': {
'agentSpaceArn': 'string',
'goalId': 'string',
'title': 'string',
'content': {
'description': 'string',
'objectives': 'string'
},
'status': 'ACTIVE'|'PAUSED'|'COMPLETE',
'goalType': 'CUSTOMER_DEFINED'|'ONCALL_REPORT',
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1),
'lastEvaluatedAt': datetime(2015, 1, 1),
'lastTaskId': 'string',
'lastSuccessfulTaskId': 'string',
'version': 123,
'evaluationSchedule': {
'state': 'ENABLED'|'DISABLED',
'expression': 'string'
}
}
}
Response Structure
(dict) --
Response structure containing the updated goal
goal (dict) --
The updated goal object
agentSpaceArn (string) --
The unique identifier for the agent space containing this goal
goalId (string) --
The unique identifier for this goal
title (string) --
The title of the goal
content (dict) --
Content of the goal
description (string) --
A detailed description of the goal.
objectives (string) --
The objectives to be achieved for this goal.
status (string) --
Current status of the goal itself
goalType (string) --
Type of goal based on its origin
createdAt (datetime) --
Timestamp when this goal was created
updatedAt (datetime) --
Timestamp when this goal was last updated
lastEvaluatedAt (datetime) --
Timestamp when the goal was last evaluated
lastTaskId (string) --
ID of the most recent task associated with this goal
lastSuccessfulTaskId (string) --
ID of the most recent successful task associated with this goal
version (integer) --
Version number for optimistic locking
evaluationSchedule (dict) --
Goal Schedule. Allows to schedule the goal to run periodically, as well as disable a goal temporarily
state (string) --
Whether the schedule is enabled or disabled
expression (string) --
Schedule expression (e.g., 'rate(7 days)')