2026/06/08 - AWS DevOps Agent Service - 13 new 14 updated api methods
Changes Add Asset APIs for managing versioned assets and asset files in AWS DevOps Agent agent spaces.
Lists the supported asset types
See also: AWS API Documentation
Request Syntax
client.list_asset_types(
nextToken='string',
maxResults=123
)
string
Pagination token from a previous response to retrieve the next page of results
integer
The maximum number of results to return in a single response
dict
Response Syntax
{
'items': [
{
'assetType': 'string',
'description': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Response structure for listing asset types
items (list) --
The list of supported asset types
(dict) --
Summary of an asset type, including its identifier and description.
assetType (string) --
The asset type identifier
description (string) --
A description of the asset type
nextToken (string) --
Pagination token to retrieve the next page of results. Absent when there are no more results.
Creates a file in an asset
See also: AWS API Documentation
Request Syntax
client.create_asset_file(
agentSpaceId='string',
assetId='string',
path='string',
content={
'bytes': b'bytes',
'text': 'string'
},
metadata={...}|[...]|123|123.4|'string'|True|None,
clientToken='string'
)
string
[REQUIRED]
The unique identifier for the agent space containing the asset
string
[REQUIRED]
The unique identifier of the asset to create the file in
string
[REQUIRED]
The path of the file within the asset
dict
[REQUIRED]
The content of the file to create
bytes (bytes) --
Binary file content
text (string) --
Text file content
:ref:`document<document>`
Optional metadata describing this file
string
A unique, case-sensitive identifier used for idempotent asset file creation
This field is autopopulated if not provided.
dict
Response Syntax
{
'file': {
'path': 'string',
'content': {
'bytes': b'bytes',
'text': 'string'
},
'metadata': {...}|[...]|123|123.4|'string'|True|None,
'version': 123,
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Response structure for creating an asset file
file (dict) --
The asset file object
path (string) --
The path of this file within the asset
content (dict) --
The content of this file
bytes (bytes) --
Binary file content
text (string) --
Text file content
metadata (:ref:`document<document>`) --
The metadata for this file
version (integer) --
The asset version this file belongs to
createdAt (datetime) --
Timestamp when this file was created
updatedAt (datetime) --
Timestamp when this file was last updated
Creates a new asset in the specified agent space
See also: AWS API Documentation
Request Syntax
client.create_asset(
agentSpaceId='string',
assetType='string',
metadata={...}|[...]|123|123.4|'string'|True|None,
content={
'file': {
'path': 'string',
'body': {
'bytes': b'bytes',
'text': 'string'
},
'metadata': {...}|[...]|123|123.4|'string'|True|None
},
'zip': {
'zipFile': b'bytes'
}
},
clientToken='string'
)
string
[REQUIRED]
The unique identifier for the agent space where the asset will be created
string
[REQUIRED]
The type of asset to create
:ref:`document<document>`
The metadata describing this asset
dict
[REQUIRED]
The content for the asset. Provide a single file or a zip bundle.
file (dict) --
A single file with path and content
path (string) -- [REQUIRED]
The path of the file within the asset
body (dict) -- [REQUIRED]
The file content
bytes (bytes) --
Binary file content
text (string) --
Text file content
metadata (:ref:`document<document>`) --
Optional metadata for this file
zip (dict) --
A zip file containing multiple files
zipFile (bytes) -- [REQUIRED]
The zip file bytes
string
A unique, case-sensitive identifier used for idempotent asset creation
This field is autopopulated if not provided.
dict
Response Syntax
{
'asset': {
'assetId': 'string',
'assetType': 'string',
'metadata': {...}|[...]|123|123.4|'string'|True|None,
'version': 123,
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Response structure for creating a new asset
asset (dict) --
The asset object
assetId (string) --
The unique identifier for this asset
assetType (string) --
The type of this asset
metadata (:ref:`document<document>`) --
The metadata for this asset
version (integer) --
The version number of this asset
createdAt (datetime) --
Timestamp when this asset was created
updatedAt (datetime) --
Timestamp when this asset was last updated
Deletes an asset and all its files from the specified agent space
See also: AWS API Documentation
Request Syntax
client.delete_asset(
agentSpaceId='string',
assetId='string'
)
string
[REQUIRED]
The unique identifier for the agent space containing the asset
string
[REQUIRED]
The unique identifier of the asset to delete
dict
Response Syntax
{}
Response Structure
(dict) --
Response structure for deleting an asset
Lists versions of an asset in the specified agent space
See also: AWS API Documentation
Request Syntax
client.list_asset_versions(
agentSpaceId='string',
assetId='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
The unique identifier for the agent space containing the asset
string
[REQUIRED]
The unique identifier of the asset whose versions to list
integer
The maximum number of results to return in a single response
string
Pagination token from a previous response to retrieve the next page of results
dict
Response Syntax
{
'items': [
{
'version': 123,
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Response structure for listing asset versions
items (list) --
The list of version metadata for the asset
(dict) --
Metadata for a single version of an asset, including the version number and timestamps.
version (integer) --
The version number of this asset
createdAt (datetime) --
Timestamp when this asset version was created
updatedAt (datetime) --
Timestamp when this asset version was last updated
nextToken (string) --
Pagination token to retrieve the next page of results. Absent when there are no more results.
Lists assets in the specified agent space
See also: AWS API Documentation
Request Syntax
client.list_assets(
agentSpaceId='string',
assetType='string',
updatedAfter=datetime(2015, 1, 1),
updatedBefore=datetime(2015, 1, 1),
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The unique identifier for the agent space to list assets from
string
Filter results to only assets of this type
datetime
Filter results to only assets updated after this timestamp
datetime
Filter results to only assets updated before this timestamp
string
Pagination token from a previous response to retrieve the next page of results
integer
The maximum number of results to return in a single response
dict
Response Syntax
{
'items': [
{
'assetId': 'string',
'assetType': 'string',
'metadata': {...}|[...]|123|123.4|'string'|True|None,
'version': 123,
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Response structure for listing assets
items (list) --
The list of assets for the agent space
(dict) --
Represents an asset in an agent space, including its identifier, type, metadata, version, and timestamps.
assetId (string) --
The unique identifier for this asset
assetType (string) --
The type of this asset
metadata (:ref:`document<document>`) --
The metadata for this asset
version (integer) --
The version number of this asset
createdAt (datetime) --
Timestamp when this asset was created
updatedAt (datetime) --
Timestamp when this asset was last updated
nextToken (string) --
Pagination token to retrieve the next page of results. Absent when there are no more results.
Gets an asset from the specified agent space
See also: AWS API Documentation
Request Syntax
client.get_asset(
agentSpaceId='string',
assetId='string',
assetVersion=123
)
string
[REQUIRED]
The unique identifier for the agent space containing the asset
string
[REQUIRED]
The unique identifier of the asset to retrieve
integer
The specific version of the asset to retrieve. If omitted, the latest version is returned.
dict
Response Syntax
{
'asset': {
'assetId': 'string',
'assetType': 'string',
'metadata': {...}|[...]|123|123.4|'string'|True|None,
'version': 123,
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Response structure for getting an asset
asset (dict) --
The asset object
assetId (string) --
The unique identifier for this asset
assetType (string) --
The type of this asset
metadata (:ref:`document<document>`) --
The metadata for this asset
version (integer) --
The version number of this asset
createdAt (datetime) --
Timestamp when this asset was created
updatedAt (datetime) --
Timestamp when this asset was last updated
Gets an asset's content as a zip bundle
See also: AWS API Documentation
Request Syntax
client.get_asset_content(
agentSpaceId='string',
assetId='string',
assetVersion=123
)
string
[REQUIRED]
The unique identifier for the agent space containing the asset
string
[REQUIRED]
The unique identifier of the asset
integer
The specific asset version to export. If omitted, the latest version is returned.
dict
Response Syntax
{
'content': {
'zipFile': b'bytes'
},
'version': 123
}
Response Structure
(dict) --
Response structure for getting an asset's content as a zip bundle
content (dict) --
The asset content as a zip file
zipFile (bytes) --
The zip file bytes
version (integer) --
The asset version this content belongs to
Lists files in an asset
See also: AWS API Documentation
Request Syntax
client.list_asset_files(
agentSpaceId='string',
assetId='string',
assetVersion=123,
nextToken='string',
maxResults=123
)
string
[REQUIRED]
The unique identifier for the agent space containing the asset
string
[REQUIRED]
The unique identifier of the asset whose files to list
integer
The specific asset version to list files from. If omitted, files from the latest version are returned.
string
Pagination token from a previous response to retrieve the next page of results
integer
The maximum number of results to return in a single response
dict
Response Syntax
{
'items': [
{
'path': 'string',
'metadata': {...}|[...]|123|123.4|'string'|True|None,
'version': 123,
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
Response structure for listing asset files
items (list) --
The list of asset file summaries
(dict) --
Summary of a file within an asset, including its path, version, and timestamps.
path (string) --
The path of this file within the asset
metadata (:ref:`document<document>`) --
The metadata for this file
version (integer) --
The asset version this file belongs to
createdAt (datetime) --
Timestamp when this file was created
updatedAt (datetime) --
Timestamp when this file was last updated
nextToken (string) --
Pagination token to retrieve the next page of results. Absent when there are no more results.
Deletes a file from an asset
See also: AWS API Documentation
Request Syntax
client.delete_asset_file(
agentSpaceId='string',
assetId='string',
path='string'
)
string
[REQUIRED]
The unique identifier for the agent space containing the asset
string
[REQUIRED]
The unique identifier of the asset containing the file
string
[REQUIRED]
The path of the file within the asset to delete
dict
Response Syntax
{}
Response Structure
(dict) --
Response structure for deleting an asset file
Gets a file from an asset
See also: AWS API Documentation
Request Syntax
client.get_asset_file(
agentSpaceId='string',
assetId='string',
path='string',
assetVersion=123
)
string
[REQUIRED]
The unique identifier for the agent space containing the asset
string
[REQUIRED]
The unique identifier of the asset containing the file
string
[REQUIRED]
The path of the file within the asset to retrieve
integer
The specific asset version to retrieve the file from. If omitted, the latest version is returned.
dict
Response Syntax
{
'file': {
'path': 'string',
'content': {
'bytes': b'bytes',
'text': 'string'
},
'metadata': {...}|[...]|123|123.4|'string'|True|None,
'version': 123,
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Response structure for getting an asset file
file (dict) --
The asset file object
path (string) --
The path of this file within the asset
content (dict) --
The content of this file
bytes (bytes) --
Binary file content
text (string) --
Text file content
metadata (:ref:`document<document>`) --
The metadata for this file
version (integer) --
The asset version this file belongs to
createdAt (datetime) --
Timestamp when this file was created
updatedAt (datetime) --
Timestamp when this file was last updated
Updates an asset in the specified agent space
See also: AWS API Documentation
Request Syntax
client.update_asset(
agentSpaceId='string',
assetId='string',
metadata={...}|[...]|123|123.4|'string'|True|None,
content={
'file': {
'path': 'string',
'body': {
'bytes': b'bytes',
'text': 'string'
},
'metadata': {...}|[...]|123|123.4|'string'|True|None
},
'zip': {
'zipFile': b'bytes'
}
},
clientToken='string'
)
string
[REQUIRED]
The unique identifier for the agent space containing the asset
string
[REQUIRED]
The unique identifier of the asset to update
:ref:`document<document>`
Metadata fields to update. Only the fields present in this document are updated. Omitted fields retain their current values.
dict
Optional content to set or replace. A single file adds or replaces one file; a zip replaces all files.
file (dict) --
A single file with path and content
path (string) -- [REQUIRED]
The path of the file within the asset
body (dict) -- [REQUIRED]
The file content
bytes (bytes) --
Binary file content
text (string) --
Text file content
metadata (:ref:`document<document>`) --
Optional metadata for this file
zip (dict) --
A zip file containing multiple files
zipFile (bytes) -- [REQUIRED]
The zip file bytes
string
A unique, case-sensitive identifier used for idempotent asset update
This field is autopopulated if not provided.
dict
Response Syntax
{
'asset': {
'assetId': 'string',
'assetType': 'string',
'metadata': {...}|[...]|123|123.4|'string'|True|None,
'version': 123,
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Response structure for updating an asset
asset (dict) --
The asset object
assetId (string) --
The unique identifier for this asset
assetType (string) --
The type of this asset
metadata (:ref:`document<document>`) --
The metadata for this asset
version (integer) --
The version number of this asset
createdAt (datetime) --
Timestamp when this asset was created
updatedAt (datetime) --
Timestamp when this asset was last updated
Updates a file in an asset
See also: AWS API Documentation
Request Syntax
client.update_asset_file(
agentSpaceId='string',
assetId='string',
path='string',
content={
'bytes': b'bytes',
'text': 'string'
},
metadata={...}|[...]|123|123.4|'string'|True|None,
clientToken='string'
)
string
[REQUIRED]
The unique identifier for the agent space containing the asset
string
[REQUIRED]
The unique identifier of the asset containing the file
string
[REQUIRED]
The path of the file within the asset to update
dict
Updated file content. If omitted, the existing content is unchanged.
bytes (bytes) --
Binary file content
text (string) --
Text file content
:ref:`document<document>`
Metadata fields to update. Only the fields present in this document are updated. Omitted fields retain their current values.
string
A unique, case-sensitive identifier used for idempotent asset file update
This field is autopopulated if not provided.
dict
Response Syntax
{
'file': {
'path': 'string',
'content': {
'bytes': b'bytes',
'text': 'string'
},
'metadata': {...}|[...]|123|123.4|'string'|True|None,
'version': 123,
'createdAt': datetime(2015, 1, 1),
'updatedAt': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
Response structure for updating an asset file
file (dict) --
The asset file object
path (string) --
The path of this file within the asset
content (dict) --
The content of this file
bytes (bytes) --
Binary file content
text (string) --
Text file content
metadata (:ref:`document<document>`) --
The metadata for this file
version (integer) --
The asset version this file belongs to
createdAt (datetime) --
Timestamp when this file was created
updatedAt (datetime) --
Timestamp when this file was last updated
{'task': {'status': {'SKIPPED'}}}
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'|'SKIPPED',
'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
{'mode': {'serviceManaged': {'dnsResolution': 'PUBLIC | IN_VPC'}}}
Response {'dnsResolution': 'PUBLIC | IN_VPC', 'failureMessage': 'string'}
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',
'dnsResolution': 'PUBLIC'|'IN_VPC'
},
'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 1-65535, enforced at runtime.
certificate (string) --
Certificate for the Private Connection.
dnsResolution (string) --
DNS resolution mode for the resource gateway. Defaults to PUBLIC when not set.
selfManaged (dict) --
Caller manages their own resource configuration.
resourceConfigurationId (string) -- [REQUIRED]
The ID or 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),
'dnsResolution': 'PUBLIC'|'IN_VPC',
'failureMessage': 'string',
'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.
dnsResolution (string) --
DNS resolution mode for the Private Connection's resource gateway.
failureMessage (string) --
Message describing the reason for a failed Private Connection creation, if applicable.
tags (dict) --
Tags associated with the created Private Connection.
(string) --
Tag key string.
(string) --
Tag value string.
{'dnsResolution': 'PUBLIC | IN_VPC', 'failureMessage': 'string'}
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),
'dnsResolution': 'PUBLIC'|'IN_VPC',
'failureMessage': 'string',
'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.
dnsResolution (string) --
DNS resolution mode for the Private Connection's resource gateway.
failureMessage (string) --
Message describing the reason for a failed Private Connection, if applicable.
tags (dict) --
Tags associated with the Private Connection.
(string) --
Tag key string.
(string) --
Tag value string.
{'operatorAppUrl': 'string'}
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',
'operatorAppUrl': '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
operatorAppUrl (string) --
The URL for operators to access the Operator App
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.
{'task': {'status': {'SKIPPED'}}}
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'|'SKIPPED',
'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
{'operatorAppUrl': 'string'}
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
{
'operatorAppUrl': '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 Operator App configuration including authentication details.
operatorAppUrl (string) --
The URL for operators to access the Operator App
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.
{'service': {'additionalServiceDetails': {'mcpserversigv4': {'mcpRoleArn': 'string'}}}}
Retrieves given service by it's unique identifier
See also: AWS API Documentation
Request Syntax
client.get_service(
serviceId='string'
)
string
[REQUIRED]
The unique identifier of the given service.
dict
Response Syntax
{
'service': {
'serviceId': 'string',
'serviceType': 'github'|'slack'|'azure'|'azuredevops'|'dynatrace'|'servicenow'|'pagerduty'|'gitlab'|'eventChannel'|'mcpservernewrelic'|'mcpservergrafana'|'mcpserverdatadog'|'mcpserver'|'mcpserversplunk'|'azureidentity'|'mcpserversigv4',
'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',
'mcpRoleArn': 'string',
'customHeaders': {
'string': '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. Use '*' for SigV4a multi-region signing.
service (string) --
AWS service name for SigV4 signing.
roleArn (string) --
IAM role ARN to assume for SigV4 signing.
mcpRoleArn (string) --
AWS IAM role ARN.
customHeaders (dict) --
Custom headers for the SigV4 MCP server.
(string) --
HTTP header name. Allows alphanumeric characters, hyphens, and underscores.
(string) --
Value type for custom headers.
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.
{'filter': {'status': {'SKIPPED'}}}
Response {'tasks': {'status': {'SKIPPED'}}}
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'|'SKIPPED',
],
'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'|'SKIPPED',
'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
{'privateConnections': {'dnsResolution': 'PUBLIC | IN_VPC',
'failureMessage': 'string'}}
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),
'dnsResolution': 'PUBLIC'|'IN_VPC',
'failureMessage': 'string'
},
]
}
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.
dnsResolution (string) --
DNS resolution mode for the Private Connection's resource gateway.
failureMessage (string) --
Message describing the reason for a failed Private Connection, if applicable.
{'services': {'additionalServiceDetails': {'mcpserversigv4': {'mcpRoleArn': 'string'}}}}
List a list of registered service on the account level.
See also: AWS API Documentation
Request Syntax
client.list_services(
maxResults=123,
nextToken='string',
filterServiceType='github'|'slack'|'azure'|'azuredevops'|'dynatrace'|'servicenow'|'pagerduty'|'gitlab'|'eventChannel'|'mcpservernewrelic'|'mcpservergrafana'|'mcpserverdatadog'|'mcpserver'|'mcpserversplunk'|'azureidentity'|'mcpserversigv4'
)
integer
Maximum number of results to return in a single call.
string
Token for the next page of results.
string
Optional filter to list only services of a specific type.
dict
Response Syntax
{
'nextToken': 'string',
'services': [
{
'serviceId': 'string',
'serviceType': 'github'|'slack'|'azure'|'azuredevops'|'dynatrace'|'servicenow'|'pagerduty'|'gitlab'|'eventChannel'|'mcpservernewrelic'|'mcpservergrafana'|'mcpserverdatadog'|'mcpserver'|'mcpserversplunk'|'azureidentity'|'mcpserversigv4',
'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',
'mcpRoleArn': 'string',
'customHeaders': {
'string': '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. Use '*' for SigV4a multi-region signing.
service (string) --
AWS service name for SigV4 signing.
roleArn (string) --
IAM role ARN to assume for SigV4 signing.
mcpRoleArn (string) --
AWS IAM role ARN.
customHeaders (dict) --
Custom headers for the SigV4 MCP server.
(string) --
HTTP header name. Allows alphanumeric characters, hyphens, and underscores.
(string) --
Value type for custom headers.
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.
{'exchangeUrlPrivateConnectionName': 'string',
'serviceDetails': {'mcpserversigv4': {'authorizationConfig': {'mcpRoleArn': 'string'}}},
'targetUrlPrivateConnectionName': 'string'}
This operation registers the specified service
See also: AWS API Documentation
Request Syntax
client.register_service(
service='dynatrace'|'servicenow'|'pagerduty'|'gitlab'|'eventChannel'|'mcpservernewrelic'|'mcpservergrafana'|'mcpserverdatadog'|'mcpserver'|'mcpserversplunk'|'azureidentity'|'mcpserversigv4',
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',
'mcpRoleArn': 'string',
'customHeaders': {
'string': 'string'
}
}
}
},
kmsKeyArn='string',
privateConnectionName='string',
targetUrlPrivateConnectionName='string',
exchangeUrlPrivateConnectionName='string',
name='string',
tags={
'string': 'string'
}
)
string
[REQUIRED]
Services that can be registered via the post-registration API (excludes OAuth 3LO services).
dict
[REQUIRED]
Service-specific authorization configuration parameters
dynatrace (dict) --
Dynatrace-specific service details.
accountUrn (string) -- [REQUIRED]
Dynatrace resource account urn.
authorizationConfig (dict) --
Dynatrace OAuth client credentials configuration. Use this when registering with OAuth client credentials flow.
oAuthClientCredentials (dict) --
OAuth client credentials configuration.
clientName (string) --
User friendly OAuth client name specified by end user.
clientId (string) -- [REQUIRED]
OAuth client ID for authenticating with the service.
exchangeParameters (dict) --
OAuth token exchange parameters for authenticating with the service.
(string) --
(string) --
Exchange Parameter value for MCP authentication
clientSecret (string) -- [REQUIRED]
OAuth client secret for authenticating with the service.
servicenow (dict) --
ServiceNow-specific service details.
instanceUrl (string) -- [REQUIRED]
ServiceNow instance URL.
authorizationConfig (dict) --
ServiceNow OAuth client credentials configuration. Use this when registering with OAuth client credentials flow.
oAuthClientCredentials (dict) --
OAuth client credentials configuration.
clientName (string) --
User friendly OAuth client name specified by end user.
clientId (string) -- [REQUIRED]
OAuth client ID for authenticating with the service.
exchangeParameters (dict) --
OAuth token exchange parameters for authenticating with the service.
(string) --
(string) --
Exchange Parameter value for MCP authentication
clientSecret (string) -- [REQUIRED]
OAuth client secret for authenticating with the service.
mcpserverdatadog (dict) --
Datadog MCP server-specific service details.
name (string) -- [REQUIRED]
MCP server name.
endpoint (string) -- [REQUIRED]
MCP server endpoint URL.
description (string) --
Optional description for the MCP server.
authorizationConfig (dict) -- [REQUIRED]
Datadog MCP server authorization configuration (only authorization discovery is supported).
authorizationDiscovery (dict) --
Datadog MCP server authorization discovery configuration.
returnToEndpoint (string) -- [REQUIRED]
The endpoint to return to after OAuth flow completes (must be AWS console domain)
mcpserver (dict) --
MCP server-specific service details.
name (string) -- [REQUIRED]
MCP server name.
endpoint (string) -- [REQUIRED]
MCP server endpoint URL.
description (string) --
Optional description for the MCP server.
authorizationConfig (dict) -- [REQUIRED]
MCP server authorization configuration.
oAuthClientCredentials (dict) --
MCP server configuration with OAuth client credentials.
clientName (string) --
User friendly OAuth client name specified by end user.
clientId (string) -- [REQUIRED]
OAuth client ID for authenticating with the service.
exchangeParameters (dict) --
OAuth token exchange parameters for authenticating with the service.
(string) --
(string) --
Exchange Parameter value for MCP authentication
clientSecret (string) -- [REQUIRED]
OAuth client secret for authenticating with the service.
exchangeUrl (string) -- [REQUIRED]
OAuth token exchange URL.
scopes (list) --
OAuth scopes for 3LO authentication. The service will always request scope offline_access.
(string) --
OAuth scope parameter
oAuth3LO (dict) --
MCP server configuration with OAuth 3LO.
clientName (string) --
User friendly OAuth client name specified by end user.
clientId (string) -- [REQUIRED]
OAuth client ID for authenticating with the service.
exchangeParameters (dict) --
OAuth token exchange parameters for authenticating with the service.
(string) --
(string) --
Exchange Parameter value for MCP authentication
returnToEndpoint (string) -- [REQUIRED]
The endpoint to return to after OAuth flow completes (must be AWS console domain)
authorizationUrl (string) -- [REQUIRED]
OAuth authorization URL for 3LO authentication.
exchangeUrl (string) -- [REQUIRED]
OAuth token exchange URL.
clientSecret (string) --
OAuth client secret for authenticating with the service. Required for confidential clients or when PKCE is not supported. Optional for public clients using PKCE.
supportCodeChallenge (boolean) --
Whether the service supports PKCE (Proof Key for Code Exchange) for enhanced security during the OAuth flow.
scopes (list) --
OAuth scopes for 3LO authentication. The service will always request scope offline_access.
(string) --
OAuth scope parameter
apiKey (dict) --
MCP server configuration with API key authentication.
apiKeyName (string) -- [REQUIRED]
User friendly API key name specified by end user.
apiKeyValue (string) -- [REQUIRED]
API key value for authenticating with the service.
apiKeyHeader (string) -- [REQUIRED]
HTTP header name to send the API key in requests to the service.
bearerToken (dict) --
MCP server configuration with Bearer token (RFC 6750).
tokenName (string) -- [REQUIRED]
User friendly bearer token name specified by end user.
tokenValue (string) -- [REQUIRED]
Bearer token value in alphanumeric for authenticating with the service.
authorizationHeader (string) --
HTTP header name to send the bearer token in requests to the service. Defaults to 'Authorization' per RFC 6750.
authorizationDiscovery (dict) --
MCP server authorization discovery configuration.
returnToEndpoint (string) -- [REQUIRED]
The endpoint to return to after OAuth flow completes (must be AWS console domain)
gitlab (dict) --
GitLab-specific service details.
targetUrl (string) -- [REQUIRED]
GitLab instance URL (e.g., https://gitlab.com or self-hosted instance).
tokenType (string) -- [REQUIRED]
Type of GitLab access token
tokenValue (string) -- [REQUIRED]
GitLab access token value
groupId (string) --
Optional GitLab group ID for group-level access tokens
mcpserversplunk (dict) --
Splunk MCP server-specific service details.
name (string) -- [REQUIRED]
MCP server name.
endpoint (string) -- [REQUIRED]
MCP server endpoint URL.
description (string) --
Optional description for the MCP server.
authorizationConfig (dict) -- [REQUIRED]
MCP server authorization configuration.
oAuthClientCredentials (dict) --
MCP server configuration with OAuth client credentials.
clientName (string) --
User friendly OAuth client name specified by end user.
clientId (string) -- [REQUIRED]
OAuth client ID for authenticating with the service.
exchangeParameters (dict) --
OAuth token exchange parameters for authenticating with the service.
(string) --
(string) --
Exchange Parameter value for MCP authentication
clientSecret (string) -- [REQUIRED]
OAuth client secret for authenticating with the service.
exchangeUrl (string) -- [REQUIRED]
OAuth token exchange URL.
scopes (list) --
OAuth scopes for 3LO authentication. The service will always request scope offline_access.
(string) --
OAuth scope parameter
oAuth3LO (dict) --
MCP server configuration with OAuth 3LO.
clientName (string) --
User friendly OAuth client name specified by end user.
clientId (string) -- [REQUIRED]
OAuth client ID for authenticating with the service.
exchangeParameters (dict) --
OAuth token exchange parameters for authenticating with the service.
(string) --
(string) --
Exchange Parameter value for MCP authentication
returnToEndpoint (string) -- [REQUIRED]
The endpoint to return to after OAuth flow completes (must be AWS console domain)
authorizationUrl (string) -- [REQUIRED]
OAuth authorization URL for 3LO authentication.
exchangeUrl (string) -- [REQUIRED]
OAuth token exchange URL.
clientSecret (string) --
OAuth client secret for authenticating with the service. Required for confidential clients or when PKCE is not supported. Optional for public clients using PKCE.
supportCodeChallenge (boolean) --
Whether the service supports PKCE (Proof Key for Code Exchange) for enhanced security during the OAuth flow.
scopes (list) --
OAuth scopes for 3LO authentication. The service will always request scope offline_access.
(string) --
OAuth scope parameter
apiKey (dict) --
MCP server configuration with API key authentication.
apiKeyName (string) -- [REQUIRED]
User friendly API key name specified by end user.
apiKeyValue (string) -- [REQUIRED]
API key value for authenticating with the service.
apiKeyHeader (string) -- [REQUIRED]
HTTP header name to send the API key in requests to the service.
bearerToken (dict) --
MCP server configuration with Bearer token (RFC 6750).
tokenName (string) -- [REQUIRED]
User friendly bearer token name specified by end user.
tokenValue (string) -- [REQUIRED]
Bearer token value in alphanumeric for authenticating with the service.
authorizationHeader (string) --
HTTP header name to send the bearer token in requests to the service. Defaults to 'Authorization' per RFC 6750.
authorizationDiscovery (dict) --
MCP server authorization discovery configuration.
returnToEndpoint (string) -- [REQUIRED]
The endpoint to return to after OAuth flow completes (must be AWS console domain)
mcpservernewrelic (dict) --
New Relic-specific service details.
authorizationConfig (dict) -- [REQUIRED]
New Relic MCP server authorization configuration.
apiKey (dict) --
New Relic API Key authentication (apiKey, accountId, region).
apiKey (string) -- [REQUIRED]
New Relic User API Key
accountId (string) -- [REQUIRED]
New Relic Account ID
region (string) -- [REQUIRED]
New Relic region (US or EU)
applicationIds (list) --
List of monitored APM application IDs in New Relic
(string) --
entityGuids (list) --
List of globally unique IDs for New Relic resources (apps, hosts, services)
(string) --
alertPolicyIds (list) --
List of alert policy IDs grouping related conditions
(string) --
eventChannel (dict) --
Event Channel specific service details.
type (string) --
The type of event channel
mcpservergrafana (dict) --
Datadog MCP server-specific service details.
name (string) -- [REQUIRED]
MCP server name.
endpoint (string) -- [REQUIRED]
MCP server endpoint URL.
description (string) --
Optional description for the MCP server.
authorizationConfig (dict) -- [REQUIRED]
Grafana MCP server authorization configuration (experimental).
oAuthClientCredentials (dict) --
MCP server configuration with OAuth client credentials.
clientName (string) --
User friendly OAuth client name specified by end user.
clientId (string) -- [REQUIRED]
OAuth client ID for authenticating with the service.
exchangeParameters (dict) --
OAuth token exchange parameters for authenticating with the service.
(string) --
(string) --
Exchange Parameter value for MCP authentication
clientSecret (string) -- [REQUIRED]
OAuth client secret for authenticating with the service.
exchangeUrl (string) -- [REQUIRED]
OAuth token exchange URL.
scopes (list) --
OAuth scopes for 3LO authentication. The service will always request scope offline_access.
(string) --
OAuth scope parameter
oAuth3LO (dict) --
MCP server configuration with OAuth 3LO.
clientName (string) --
User friendly OAuth client name specified by end user.
clientId (string) -- [REQUIRED]
OAuth client ID for authenticating with the service.
exchangeParameters (dict) --
OAuth token exchange parameters for authenticating with the service.
(string) --
(string) --
Exchange Parameter value for MCP authentication
returnToEndpoint (string) -- [REQUIRED]
The endpoint to return to after OAuth flow completes (must be AWS console domain)
authorizationUrl (string) -- [REQUIRED]
OAuth authorization URL for 3LO authentication.
exchangeUrl (string) -- [REQUIRED]
OAuth token exchange URL.
clientSecret (string) --
OAuth client secret for authenticating with the service. Required for confidential clients or when PKCE is not supported. Optional for public clients using PKCE.
supportCodeChallenge (boolean) --
Whether the service supports PKCE (Proof Key for Code Exchange) for enhanced security during the OAuth flow.
scopes (list) --
OAuth scopes for 3LO authentication. The service will always request scope offline_access.
(string) --
OAuth scope parameter
apiKey (dict) --
MCP server configuration with API key authentication.
apiKeyName (string) -- [REQUIRED]
User friendly API key name specified by end user.
apiKeyValue (string) -- [REQUIRED]
API key value for authenticating with the service.
apiKeyHeader (string) -- [REQUIRED]
HTTP header name to send the API key in requests to the service.
bearerToken (dict) --
MCP server configuration with Bearer token (RFC 6750).
tokenName (string) -- [REQUIRED]
User friendly bearer token name specified by end user.
tokenValue (string) -- [REQUIRED]
Bearer token value in alphanumeric for authenticating with the service.
authorizationHeader (string) --
HTTP header name to send the bearer token in requests to the service. Defaults to 'Authorization' per RFC 6750.
authorizationDiscovery (dict) --
MCP server authorization discovery configuration.
returnToEndpoint (string) -- [REQUIRED]
The endpoint to return to after OAuth flow completes (must be AWS console domain)
pagerduty (dict) --
PagerDuty specific service details.
scopes (list) -- [REQUIRED]
PagerDuty scopes.
(string) --
authorizationConfig (dict) -- [REQUIRED]
PagerDuty authorization configuration
oAuthClientCredentials (dict) --
OAuth client credentials configuration.
clientName (string) --
User friendly OAuth client name specified by end user.
clientId (string) -- [REQUIRED]
OAuth client ID for authenticating with the service.
exchangeParameters (dict) --
OAuth token exchange parameters for authenticating with the service.
(string) --
(string) --
Exchange Parameter value for MCP authentication
clientSecret (string) -- [REQUIRED]
OAuth client secret for authenticating with the service.
azureidentity (dict) --
Azure integration with AWS Outbound Identity Federation specific service details.
tenantId (string) -- [REQUIRED]
The Azure Active Directory tenant ID for the identity.
clientId (string) -- [REQUIRED]
The client ID of the service principal or managed identity used for authentication.
webIdentityRoleArn (string) -- [REQUIRED]
The role ARN to be assumed by DevOps Agent for requesting Web Identity Token.
webIdentityTokenAudiences (list) -- [REQUIRED]
The audiences for the Web Identity Token.
(string) --
mcpserversigv4 (dict) --
SigV4-authenticated MCP server-specific service details.
name (string) -- [REQUIRED]
MCP server name.
endpoint (string) -- [REQUIRED]
MCP server endpoint URL.
description (string) --
Optional description for the MCP server.
authorizationConfig (dict) -- [REQUIRED]
MCP Server SigV4 authorization configuration.
region (string) -- [REQUIRED]
AWS region for SigV4 signing. Use '*' for SigV4a multi-region signing.
service (string) -- [REQUIRED]
AWS service name for SigV4 signing.
roleArn (string) --
Deprecated — use mcpRoleArn instead. IAM role ARN to assume for SigV4 signing.
mcpRoleArn (string) --
IAM role ARN to assume for SigV4 signing. Optional — when omitted, credentials are resolved at runtime via a monitor account association.
customHeaders (dict) --
Custom headers for the SigV4 MCP server.
(string) --
HTTP header name. Allows alphanumeric characters, hyphens, and underscores.
(string) --
Value type for custom headers.
string
The ARN of the AWS Key Management Service (AWS KMS) customer managed key that's used to encrypt resources.
string
The name of the private connection to use for VPC connectivity.
string
The name of the private connection to use for API calls (target URL) only. Cannot be specified when privateConnectionName is provided.
string
The name of the private connection to use for OAuth token exchange requests only. Cannot be specified when privateConnectionName is provided.
string
The display name for the service registration.
dict
Tags to add to the Service at registration time.
(string) --
Tag key string.
(string) --
Tag value string.
dict
Response Syntax
{
'serviceId': 'string',
'additionalStep': {
'oauth': {
'authorizationUrl': 'string'
}
},
'kmsKeyArn': 'string',
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
Output containing the service ID and any additional steps required for registration.
serviceId (string) --
Service ID - present when registration is complete, absent when additional steps are required
additionalStep (dict) --
Indicates if additional steps are required to complete service registration (e.g., 3-legged OAuth)
oauth (dict) --
OAuth authorization step required.
authorizationUrl (string) --
The URL to redirect the user to for OAuth authorization.
kmsKeyArn (string) --
The ARN of the AWS Key Management Service (AWS KMS) customer managed key that's used to encrypt resources.
tags (dict) --
Tags associated with the registered Service.
(string) --
Tag key string.
(string) --
Tag value string.
{'assetIds': ['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',
assetIds=[
'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
User identifier. This field is deprecated and will be ignored — the service resolves user identity from the authenticated session.
list
Optional list of asset identifiers to attach to the message
(string) --
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
{'taskStatus': {'SKIPPED'}}
Response {'task': {'status': {'SKIPPED'}}}
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'|'SKIPPED',
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'|'SKIPPED',
'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
{'dnsResolution': 'PUBLIC | IN_VPC', 'failureMessage': 'string'}
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),
'dnsResolution': 'PUBLIC'|'IN_VPC',
'failureMessage': 'string'
}
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.
dnsResolution (string) --
DNS resolution mode for the Private Connection's resource gateway.
failureMessage (string) --
Message describing the reason for a failed Private Connection update, if applicable.