Skip to content

DevOpsAgentServiceClient#

Index > DevOpsAgentService > DevOpsAgentServiceClient

Auto-generated documentation for DevOpsAgentService type annotations stubs module mypy-boto3-devops-agent.

DevOpsAgentServiceClient#

Type annotations and code completion for boto3.client("devops-agent"). boto3 documentation

# DevOpsAgentServiceClient usage example

from boto3.session import Session
from mypy_boto3_devops_agent.client import DevOpsAgentServiceClient

def get_devops-agent_client() -> DevOpsAgentServiceClient:
    return Session().client("devops-agent")

Exceptions#

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("devops-agent").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("devops-agent")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.ContentSizeExceededException,
    client.exceptions.IdentityCenterServiceException,
    client.exceptions.InternalServerException,
    client.exceptions.InvalidParameterException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_devops_agent.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods#

can_paginate#

Type annotations and code completion for boto3.client("devops-agent").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url#

Type annotations and code completion for boto3.client("devops-agent").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

allow_vended_log_delivery_for_resource#

Authorize Ingestion Hub subscription operation.

Type annotations and code completion for boto3.client("devops-agent").allow_vended_log_delivery_for_resource method. boto3 documentation

# allow_vended_log_delivery_for_resource method definition

def allow_vended_log_delivery_for_resource(
    self,
    *,
    resourceArnBeingAuthorized: str,
    deliverySourceArn: str,
    logType: str = ...,
) -> AllowVendedLogDeliveryForResourceOutputTypeDef:  # (1)
    ...
  1. See AllowVendedLogDeliveryForResourceOutputTypeDef
# allow_vended_log_delivery_for_resource method usage example with argument unpacking

kwargs: AllowVendedLogDeliveryForResourceInputTypeDef = {  # (1)
    "resourceArnBeingAuthorized": ...,
    "deliverySourceArn": ...,
}

parent.allow_vended_log_delivery_for_resource(**kwargs)
  1. See AllowVendedLogDeliveryForResourceInputTypeDef

associate_service#

Adds a specific service association to an AgentSpace.

Type annotations and code completion for boto3.client("devops-agent").associate_service method. boto3 documentation

# associate_service method definition

def associate_service(
    self,
    *,
    agentSpaceId: str,
    serviceId: str,
    configuration: ServiceConfigurationUnionTypeDef,  # (1)
) -> AssociateServiceOutputTypeDef:  # (2)
    ...
  1. See ServiceConfigurationUnionTypeDef
  2. See AssociateServiceOutputTypeDef
# associate_service method usage example with argument unpacking

kwargs: AssociateServiceInputTypeDef = {  # (1)
    "agentSpaceId": ...,
    "serviceId": ...,
    "configuration": ...,
}

parent.associate_service(**kwargs)
  1. See AssociateServiceInputTypeDef

create_agent_space#

Creates a new AgentSpace with the specified name and description.

Type annotations and code completion for boto3.client("devops-agent").create_agent_space method. boto3 documentation

# create_agent_space method definition

def create_agent_space(
    self,
    *,
    name: str,
    description: str = ...,
    locale: str = ...,
    kmsKeyArn: str = ...,
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateAgentSpaceOutputTypeDef:  # (1)
    ...
  1. See CreateAgentSpaceOutputTypeDef
# create_agent_space method usage example with argument unpacking

kwargs: CreateAgentSpaceInputTypeDef = {  # (1)
    "name": ...,
}

parent.create_agent_space(**kwargs)
  1. See CreateAgentSpaceInputTypeDef

create_backlog_task#

Creates a new backlog task in the specified agent space.

Type annotations and code completion for boto3.client("devops-agent").create_backlog_task method. boto3 documentation

# create_backlog_task method definition

def create_backlog_task(
    self,
    *,
    agentSpaceId: str,
    taskType: TaskTypeType,  # (1)
    title: str,
    priority: PriorityType,  # (2)
    reference: ReferenceInputTypeDef = ...,  # (3)
    description: str = ...,
    clientToken: str = ...,
) -> CreateBacklogTaskResponseTypeDef:  # (4)
    ...
  1. See TaskTypeType
  2. See PriorityType
  3. See ReferenceInputTypeDef
  4. See CreateBacklogTaskResponseTypeDef
# create_backlog_task method usage example with argument unpacking

kwargs: CreateBacklogTaskRequestTypeDef = {  # (1)
    "agentSpaceId": ...,
    "taskType": ...,
    "title": ...,
    "priority": ...,
}

parent.create_backlog_task(**kwargs)
  1. See CreateBacklogTaskRequestTypeDef

create_chat#

Creates a new chat execution in the specified agent space.

Type annotations and code completion for boto3.client("devops-agent").create_chat method. boto3 documentation

# create_chat method definition

def create_chat(
    self,
    *,
    agentSpaceId: str,
    userId: str,
    userType: UserTypeType = ...,  # (1)
) -> CreateChatResponseTypeDef:  # (2)
    ...
  1. See UserTypeType
  2. See CreateChatResponseTypeDef
# create_chat method usage example with argument unpacking

kwargs: CreateChatRequestTypeDef = {  # (1)
    "agentSpaceId": ...,
    "userId": ...,
}

parent.create_chat(**kwargs)
  1. See CreateChatRequestTypeDef

create_private_connection#

Creates a Private Connection to a target resource.

Type annotations and code completion for boto3.client("devops-agent").create_private_connection method. boto3 documentation

# create_private_connection method definition

def create_private_connection(
    self,
    *,
    name: str,
    mode: PrivateConnectionModeTypeDef,  # (1)
    tags: Mapping[str, str] = ...,
) -> CreatePrivateConnectionOutputTypeDef:  # (2)
    ...
  1. See PrivateConnectionModeTypeDef
  2. See CreatePrivateConnectionOutputTypeDef
# create_private_connection method usage example with argument unpacking

kwargs: CreatePrivateConnectionInputTypeDef = {  # (1)
    "name": ...,
    "mode": ...,
}

parent.create_private_connection(**kwargs)
  1. See CreatePrivateConnectionInputTypeDef

delete_agent_space#

Deletes an AgentSpace.

Type annotations and code completion for boto3.client("devops-agent").delete_agent_space method. boto3 documentation

# delete_agent_space method definition

def delete_agent_space(
    self,
    *,
    agentSpaceId: str,
) -> dict[str, Any]:
    ...
# delete_agent_space method usage example with argument unpacking

kwargs: DeleteAgentSpaceInputTypeDef = {  # (1)
    "agentSpaceId": ...,
}

parent.delete_agent_space(**kwargs)
  1. See DeleteAgentSpaceInputTypeDef

delete_private_connection#

Deletes a Private Connection.

Type annotations and code completion for boto3.client("devops-agent").delete_private_connection method. boto3 documentation

# delete_private_connection method definition

def delete_private_connection(
    self,
    *,
    name: str,
) -> DeletePrivateConnectionOutputTypeDef:  # (1)
    ...
  1. See DeletePrivateConnectionOutputTypeDef
# delete_private_connection method usage example with argument unpacking

kwargs: DeletePrivateConnectionInputTypeDef = {  # (1)
    "name": ...,
}

parent.delete_private_connection(**kwargs)
  1. See DeletePrivateConnectionInputTypeDef

deregister_service#

Deregister a service.

Type annotations and code completion for boto3.client("devops-agent").deregister_service method. boto3 documentation

# deregister_service method definition

def deregister_service(
    self,
    *,
    serviceId: str,
) -> dict[str, Any]:
    ...
# deregister_service method usage example with argument unpacking

kwargs: DeregisterServiceInputTypeDef = {  # (1)
    "serviceId": ...,
}

parent.deregister_service(**kwargs)
  1. See DeregisterServiceInputTypeDef

describe_private_connection#

Retrieves details of an existing Private Connection.

Type annotations and code completion for boto3.client("devops-agent").describe_private_connection method. boto3 documentation

# describe_private_connection method definition

def describe_private_connection(
    self,
    *,
    name: str,
) -> DescribePrivateConnectionOutputTypeDef:  # (1)
    ...
  1. See DescribePrivateConnectionOutputTypeDef
# describe_private_connection method usage example with argument unpacking

kwargs: DescribePrivateConnectionInputTypeDef = {  # (1)
    "name": ...,
}

parent.describe_private_connection(**kwargs)
  1. See DescribePrivateConnectionInputTypeDef

describe_support_level#

Describe the support level of a CloudSmith customer account.

Type annotations and code completion for boto3.client("devops-agent").describe_support_level method. boto3 documentation

# describe_support_level method definition

def describe_support_level(
    self,
    *,
    agentSpaceId: str,
    taskId: str,
) -> DescribeSupportLevelResponseTypeDef:  # (1)
    ...
  1. See DescribeSupportLevelResponseTypeDef
# describe_support_level method usage example with argument unpacking

kwargs: DescribeSupportLevelRequestTypeDef = {  # (1)
    "agentSpaceId": ...,
    "taskId": ...,
}

parent.describe_support_level(**kwargs)
  1. See DescribeSupportLevelRequestTypeDef

disable_operator_app#

Disable the Operator App for the specified AgentSpace.

Type annotations and code completion for boto3.client("devops-agent").disable_operator_app method. boto3 documentation

# disable_operator_app method definition

def disable_operator_app(
    self,
    *,
    agentSpaceId: str,
    authFlow: AuthFlowType = ...,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See AuthFlowType
  2. See EmptyResponseMetadataTypeDef
# disable_operator_app method usage example with argument unpacking

kwargs: DisableOperatorAppInputTypeDef = {  # (1)
    "agentSpaceId": ...,
}

parent.disable_operator_app(**kwargs)
  1. See DisableOperatorAppInputTypeDef

disassociate_service#

Deletes a specific service association from an AgentSpace.

Type annotations and code completion for boto3.client("devops-agent").disassociate_service method. boto3 documentation

# disassociate_service method definition

def disassociate_service(
    self,
    *,
    agentSpaceId: str,
    associationId: str,
) -> dict[str, Any]:
    ...
# disassociate_service method usage example with argument unpacking

kwargs: DisassociateServiceInputTypeDef = {  # (1)
    "agentSpaceId": ...,
    "associationId": ...,
}

parent.disassociate_service(**kwargs)
  1. See DisassociateServiceInputTypeDef

enable_operator_app#

Enable the Operator App to access the given AgentSpace.

Type annotations and code completion for boto3.client("devops-agent").enable_operator_app method. boto3 documentation

# enable_operator_app method definition

def enable_operator_app(
    self,
    *,
    agentSpaceId: str,
    authFlow: AuthFlowType,  # (1)
    operatorAppRoleArn: str,
    idcInstanceArn: str = ...,
    issuerUrl: str = ...,
    idpClientId: str = ...,
    idpClientSecret: str = ...,
    provider: str = ...,
) -> EnableOperatorAppOutputTypeDef:  # (2)
    ...
  1. See AuthFlowType
  2. See EnableOperatorAppOutputTypeDef
# enable_operator_app method usage example with argument unpacking

kwargs: EnableOperatorAppInputTypeDef = {  # (1)
    "agentSpaceId": ...,
    "authFlow": ...,
    "operatorAppRoleArn": ...,
}

parent.enable_operator_app(**kwargs)
  1. See EnableOperatorAppInputTypeDef

end_chat_for_case#

End a chat session for a support case in the specified agent space.

Type annotations and code completion for boto3.client("devops-agent").end_chat_for_case method. boto3 documentation

# end_chat_for_case method definition

def end_chat_for_case(
    self,
    *,
    agentSpaceId: str,
    taskId: str,
    reason: str = ...,
    requester: str = ...,
    clientToken: str = ...,
) -> EndChatForCaseResponseTypeDef:  # (1)
    ...
  1. See EndChatForCaseResponseTypeDef
# end_chat_for_case method usage example with argument unpacking

kwargs: EndChatForCaseRequestTypeDef = {  # (1)
    "agentSpaceId": ...,
    "taskId": ...,
}

parent.end_chat_for_case(**kwargs)
  1. See EndChatForCaseRequestTypeDef

get_account_usage#

Retrieves monthly account usage metrics and limits for the AWS account.

Type annotations and code completion for boto3.client("devops-agent").get_account_usage method. boto3 documentation

# get_account_usage method definition

def get_account_usage(
    self,
) -> GetAccountUsageOutputTypeDef:  # (1)
    ...
  1. See GetAccountUsageOutputTypeDef

get_agent_space#

Retrieves detailed information about a specific AgentSpace.

Type annotations and code completion for boto3.client("devops-agent").get_agent_space method. boto3 documentation

# get_agent_space method definition

def get_agent_space(
    self,
    *,
    agentSpaceId: str,
) -> GetAgentSpaceOutputTypeDef:  # (1)
    ...
  1. See GetAgentSpaceOutputTypeDef
# get_agent_space method usage example with argument unpacking

kwargs: GetAgentSpaceInputTypeDef = {  # (1)
    "agentSpaceId": ...,
}

parent.get_agent_space(**kwargs)
  1. See GetAgentSpaceInputTypeDef

get_association#

Retrieves given associations configured for a specific AgentSpace.

Type annotations and code completion for boto3.client("devops-agent").get_association method. boto3 documentation

# get_association method definition

def get_association(
    self,
    *,
    agentSpaceId: str,
    associationId: str,
) -> GetAssociationOutputTypeDef:  # (1)
    ...
  1. See GetAssociationOutputTypeDef
# get_association method usage example with argument unpacking

kwargs: GetAssociationInputTypeDef = {  # (1)
    "agentSpaceId": ...,
    "associationId": ...,
}

parent.get_association(**kwargs)
  1. See GetAssociationInputTypeDef

get_backlog_task#

Gets a backlog task for the specified agent space and task id.

Type annotations and code completion for boto3.client("devops-agent").get_backlog_task method. boto3 documentation

# get_backlog_task method definition

def get_backlog_task(
    self,
    *,
    agentSpaceId: str,
    taskId: str,
) -> GetBacklogTaskResponseTypeDef:  # (1)
    ...
  1. See GetBacklogTaskResponseTypeDef
# get_backlog_task method usage example with argument unpacking

kwargs: GetBacklogTaskRequestTypeDef = {  # (1)
    "agentSpaceId": ...,
    "taskId": ...,
}

parent.get_backlog_task(**kwargs)
  1. See GetBacklogTaskRequestTypeDef

get_operator_app#

Get the full auth configuration of operator including any enabled auth flow.

Type annotations and code completion for boto3.client("devops-agent").get_operator_app method. boto3 documentation

# get_operator_app method definition

def get_operator_app(
    self,
    *,
    agentSpaceId: str,
) -> GetOperatorAppOutputTypeDef:  # (1)
    ...
  1. See GetOperatorAppOutputTypeDef
# get_operator_app method usage example with argument unpacking

kwargs: GetOperatorAppInputTypeDef = {  # (1)
    "agentSpaceId": ...,
}

parent.get_operator_app(**kwargs)
  1. See GetOperatorAppInputTypeDef

get_recommendation#

Retrieves a specific recommendation by its ID.

Type annotations and code completion for boto3.client("devops-agent").get_recommendation method. boto3 documentation

# get_recommendation method definition

def get_recommendation(
    self,
    *,
    agentSpaceId: str,
    recommendationId: str,
    recommendationVersion: int = ...,
) -> GetRecommendationResponseTypeDef:  # (1)
    ...
  1. See GetRecommendationResponseTypeDef
# get_recommendation method usage example with argument unpacking

kwargs: GetRecommendationRequestTypeDef = {  # (1)
    "agentSpaceId": ...,
    "recommendationId": ...,
}

parent.get_recommendation(**kwargs)
  1. See GetRecommendationRequestTypeDef

get_service#

Retrieves given service by it's unique identifier.

Type annotations and code completion for boto3.client("devops-agent").get_service method. boto3 documentation

# get_service method definition

def get_service(
    self,
    *,
    serviceId: str,
) -> GetServiceOutputTypeDef:  # (1)
    ...
  1. See GetServiceOutputTypeDef
# get_service method usage example with argument unpacking

kwargs: GetServiceInputTypeDef = {  # (1)
    "serviceId": ...,
}

parent.get_service(**kwargs)
  1. See GetServiceInputTypeDef

initiate_chat_for_case#

Initiate a chat for support case in the specified agent space.

Type annotations and code completion for boto3.client("devops-agent").initiate_chat_for_case method. boto3 documentation

# initiate_chat_for_case method definition

def initiate_chat_for_case(
    self,
    *,
    agentSpaceId: str,
    taskId: str,
    clientToken: str = ...,
) -> InitiateChatForCaseResponseTypeDef:  # (1)
    ...
  1. See InitiateChatForCaseResponseTypeDef
# initiate_chat_for_case method usage example with argument unpacking

kwargs: InitiateChatForCaseRequestTypeDef = {  # (1)
    "agentSpaceId": ...,
    "taskId": ...,
}

parent.initiate_chat_for_case(**kwargs)
  1. See InitiateChatForCaseRequestTypeDef

list_agent_spaces#

Lists all AgentSpaces with optional pagination.

Type annotations and code completion for boto3.client("devops-agent").list_agent_spaces method. boto3 documentation

# list_agent_spaces method definition

def list_agent_spaces(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAgentSpacesOutputTypeDef:  # (1)
    ...
  1. See ListAgentSpacesOutputTypeDef
# list_agent_spaces method usage example with argument unpacking

kwargs: ListAgentSpacesInputTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_agent_spaces(**kwargs)
  1. See ListAgentSpacesInputTypeDef

list_associations#

List all associations for given AgentSpace.

Type annotations and code completion for boto3.client("devops-agent").list_associations method. boto3 documentation

# list_associations method definition

def list_associations(
    self,
    *,
    agentSpaceId: str,
    maxResults: int = ...,
    nextToken: str = ...,
    filterServiceTypes: str = ...,
) -> ListAssociationsOutputTypeDef:  # (1)
    ...
  1. See ListAssociationsOutputTypeDef
# list_associations method usage example with argument unpacking

kwargs: ListAssociationsInputTypeDef = {  # (1)
    "agentSpaceId": ...,
}

parent.list_associations(**kwargs)
  1. See ListAssociationsInputTypeDef

list_backlog_tasks#

Lists backlog tasks in the specified agent space with optional filtering and sorting.

Type annotations and code completion for boto3.client("devops-agent").list_backlog_tasks method. boto3 documentation

# list_backlog_tasks method definition

def list_backlog_tasks(
    self,
    *,
    agentSpaceId: str,
    filter: TaskFilterTypeDef = ...,  # (1)
    limit: int = ...,
    nextToken: str = ...,
    sortField: TaskSortFieldType = ...,  # (2)
    order: TaskSortOrderType = ...,  # (3)
) -> ListBacklogTasksResponseTypeDef:  # (4)
    ...
  1. See TaskFilterTypeDef
  2. See TaskSortFieldType
  3. See TaskSortOrderType
  4. See ListBacklogTasksResponseTypeDef
# list_backlog_tasks method usage example with argument unpacking

kwargs: ListBacklogTasksRequestTypeDef = {  # (1)
    "agentSpaceId": ...,
}

parent.list_backlog_tasks(**kwargs)
  1. See ListBacklogTasksRequestTypeDef

list_chats#

Retrieves a paginated list of the user's recent chat executions.

Type annotations and code completion for boto3.client("devops-agent").list_chats method. boto3 documentation

# list_chats method definition

def list_chats(
    self,
    *,
    agentSpaceId: str,
    userId: str,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListChatsResponseTypeDef:  # (1)
    ...
  1. See ListChatsResponseTypeDef
# list_chats method usage example with argument unpacking

kwargs: ListChatsRequestTypeDef = {  # (1)
    "agentSpaceId": ...,
    "userId": ...,
}

parent.list_chats(**kwargs)
  1. See ListChatsRequestTypeDef

list_executions#

List executions.

Type annotations and code completion for boto3.client("devops-agent").list_executions method. boto3 documentation

# list_executions method definition

def list_executions(
    self,
    *,
    agentSpaceId: str,
    taskId: str,
    limit: int = ...,
    nextToken: str = ...,
) -> ListExecutionsResponseTypeDef:  # (1)
    ...
  1. See ListExecutionsResponseTypeDef
# list_executions method usage example with argument unpacking

kwargs: ListExecutionsRequestTypeDef = {  # (1)
    "agentSpaceId": ...,
    "taskId": ...,
}

parent.list_executions(**kwargs)
  1. See ListExecutionsRequestTypeDef

list_goals#

Lists goals in the specified agent space with optional filtering.

Type annotations and code completion for boto3.client("devops-agent").list_goals method. boto3 documentation

# list_goals method definition

def list_goals(
    self,
    *,
    agentSpaceId: str,
    status: GoalStatusType = ...,  # (1)
    goalType: GoalTypeType = ...,  # (2)
    limit: int = ...,
    nextToken: str = ...,
) -> ListGoalsResponseTypeDef:  # (3)
    ...
  1. See GoalStatusType
  2. See GoalTypeType
  3. See ListGoalsResponseTypeDef
# list_goals method usage example with argument unpacking

kwargs: ListGoalsRequestTypeDef = {  # (1)
    "agentSpaceId": ...,
}

parent.list_goals(**kwargs)
  1. See ListGoalsRequestTypeDef

list_journal_records#

List journal records for a specific execution.

Type annotations and code completion for boto3.client("devops-agent").list_journal_records method. boto3 documentation

# list_journal_records method definition

def list_journal_records(
    self,
    *,
    agentSpaceId: str,
    executionId: str,
    limit: int = ...,
    nextToken: str = ...,
    recordType: str = ...,
    order: OrderTypeType = ...,  # (1)
) -> ListJournalRecordsResponseTypeDef:  # (2)
    ...
  1. See OrderTypeType
  2. See ListJournalRecordsResponseTypeDef
# list_journal_records method usage example with argument unpacking

kwargs: ListJournalRecordsRequestTypeDef = {  # (1)
    "agentSpaceId": ...,
    "executionId": ...,
}

parent.list_journal_records(**kwargs)
  1. See ListJournalRecordsRequestTypeDef

list_pending_messages#

List pending messages for a specific execution.

Type annotations and code completion for boto3.client("devops-agent").list_pending_messages method. boto3 documentation

# list_pending_messages method definition

def list_pending_messages(
    self,
    *,
    agentSpaceId: str,
    executionId: str,
) -> ListPendingMessagesResponseTypeDef:  # (1)
    ...
  1. See ListPendingMessagesResponseTypeDef
# list_pending_messages method usage example with argument unpacking

kwargs: ListPendingMessagesRequestTypeDef = {  # (1)
    "agentSpaceId": ...,
    "executionId": ...,
}

parent.list_pending_messages(**kwargs)
  1. See ListPendingMessagesRequestTypeDef

list_private_connections#

Lists all Private Connections in the caller's account.

Type annotations and code completion for boto3.client("devops-agent").list_private_connections method. boto3 documentation

# list_private_connections method definition

def list_private_connections(
    self,
) -> ListPrivateConnectionsOutputTypeDef:  # (1)
    ...
  1. See ListPrivateConnectionsOutputTypeDef

list_recommendations#

Lists recommendations for the specified agent space.

Type annotations and code completion for boto3.client("devops-agent").list_recommendations method. boto3 documentation

# list_recommendations method definition

def list_recommendations(
    self,
    *,
    agentSpaceId: str,
    taskId: str = ...,
    goalId: str = ...,
    status: RecommendationStatusType = ...,  # (1)
    priority: RecommendationPriorityType = ...,  # (2)
    limit: int = ...,
    nextToken: str = ...,
) -> ListRecommendationsResponseTypeDef:  # (3)
    ...
  1. See RecommendationStatusType
  2. See RecommendationPriorityType
  3. See ListRecommendationsResponseTypeDef
# list_recommendations method usage example with argument unpacking

kwargs: ListRecommendationsRequestTypeDef = {  # (1)
    "agentSpaceId": ...,
}

parent.list_recommendations(**kwargs)
  1. See ListRecommendationsRequestTypeDef

list_services#

List a list of registered service on the account level.

Type annotations and code completion for boto3.client("devops-agent").list_services method. boto3 documentation

# list_services method definition

def list_services(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    filterServiceType: ServiceType = ...,  # (1)
) -> ListServicesOutputTypeDef:  # (2)
    ...
  1. See ServiceType
  2. See ListServicesOutputTypeDef
# list_services method usage example with argument unpacking

kwargs: ListServicesInputTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_services(**kwargs)
  1. See ListServicesInputTypeDef

list_tags_for_resource#

Lists tags for the specified AWS DevOps Agent resource.

Type annotations and code completion for boto3.client("devops-agent").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...
  1. See ListTagsForResourceResponseTypeDef
# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)
  1. See ListTagsForResourceRequestTypeDef

list_webhooks#

List all webhooks for given Association.

Type annotations and code completion for boto3.client("devops-agent").list_webhooks method. boto3 documentation

# list_webhooks method definition

def list_webhooks(
    self,
    *,
    agentSpaceId: str,
    associationId: str,
) -> ListWebhooksOutputTypeDef:  # (1)
    ...
  1. See ListWebhooksOutputTypeDef
# list_webhooks method usage example with argument unpacking

kwargs: ListWebhooksInputTypeDef = {  # (1)
    "agentSpaceId": ...,
    "associationId": ...,
}

parent.list_webhooks(**kwargs)
  1. See ListWebhooksInputTypeDef

register_service#

This operation registers the specified service.

Type annotations and code completion for boto3.client("devops-agent").register_service method. boto3 documentation

# register_service method definition

def register_service(
    self,
    *,
    service: PostRegisterServiceSupportedServiceType,  # (1)
    serviceDetails: ServiceDetailsTypeDef,  # (2)
    kmsKeyArn: str = ...,
    privateConnectionName: str = ...,
    name: str = ...,
    tags: Mapping[str, str] = ...,
) -> RegisterServiceOutputTypeDef:  # (3)
    ...
  1. See PostRegisterServiceSupportedServiceType
  2. See ServiceDetailsTypeDef
  3. See RegisterServiceOutputTypeDef
# register_service method usage example with argument unpacking

kwargs: RegisterServiceInputTypeDef = {  # (1)
    "service": ...,
    "serviceDetails": ...,
}

parent.register_service(**kwargs)
  1. See RegisterServiceInputTypeDef

send_message#

Sends a chat message and streams the response for the specified agent space execution.

Type annotations and code completion for boto3.client("devops-agent").send_message method. boto3 documentation

# send_message method definition

def send_message(
    self,
    *,
    agentSpaceId: str,
    executionId: str,
    content: str,
    userId: str,
    context: SendMessageContextTypeDef = ...,  # (1)
) -> SendMessageResponseTypeDef:  # (2)
    ...
  1. See SendMessageContextTypeDef
  2. See SendMessageResponseTypeDef
# send_message method usage example with argument unpacking

kwargs: SendMessageRequestTypeDef = {  # (1)
    "agentSpaceId": ...,
    "executionId": ...,
    "content": ...,
    "userId": ...,
}

parent.send_message(**kwargs)
  1. See SendMessageRequestTypeDef

tag_resource#

Adds or overwrites tags for the specified AWS DevOps Agent resource.

Type annotations and code completion for boto3.client("devops-agent").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> dict[str, Any]:
    ...
# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)
  1. See TagResourceRequestTypeDef

untag_resource#

Removes tags from the specified AWS DevOps Agent resource.

Type annotations and code completion for boto3.client("devops-agent").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> dict[str, Any]:
    ...
# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)
  1. See UntagResourceRequestTypeDef

update_agent_space#

Updates the information of an existing AgentSpace.

Type annotations and code completion for boto3.client("devops-agent").update_agent_space method. boto3 documentation

# update_agent_space method definition

def update_agent_space(
    self,
    *,
    agentSpaceId: str,
    name: str = ...,
    description: str = ...,
    locale: str = ...,
) -> UpdateAgentSpaceOutputTypeDef:  # (1)
    ...
  1. See UpdateAgentSpaceOutputTypeDef
# update_agent_space method usage example with argument unpacking

kwargs: UpdateAgentSpaceInputTypeDef = {  # (1)
    "agentSpaceId": ...,
}

parent.update_agent_space(**kwargs)
  1. See UpdateAgentSpaceInputTypeDef

update_association#

Partially updates the configuration of an existing service association for an AgentSpace.

Type annotations and code completion for boto3.client("devops-agent").update_association method. boto3 documentation

# update_association method definition

def update_association(
    self,
    *,
    agentSpaceId: str,
    associationId: str,
    configuration: ServiceConfigurationUnionTypeDef,  # (1)
) -> UpdateAssociationOutputTypeDef:  # (2)
    ...
  1. See ServiceConfigurationUnionTypeDef
  2. See UpdateAssociationOutputTypeDef
# update_association method usage example with argument unpacking

kwargs: UpdateAssociationInputTypeDef = {  # (1)
    "agentSpaceId": ...,
    "associationId": ...,
    "configuration": ...,
}

parent.update_association(**kwargs)
  1. See UpdateAssociationInputTypeDef

update_backlog_task#

Update an existing backlog task.

Type annotations and code completion for boto3.client("devops-agent").update_backlog_task method. boto3 documentation

# update_backlog_task method definition

def update_backlog_task(
    self,
    *,
    agentSpaceId: str,
    taskId: str,
    taskStatus: TaskStatusType = ...,  # (1)
    clientToken: str = ...,
) -> UpdateBacklogTaskResponseTypeDef:  # (2)
    ...
  1. See TaskStatusType
  2. See UpdateBacklogTaskResponseTypeDef
# update_backlog_task method usage example with argument unpacking

kwargs: UpdateBacklogTaskRequestTypeDef = {  # (1)
    "agentSpaceId": ...,
    "taskId": ...,
}

parent.update_backlog_task(**kwargs)
  1. See UpdateBacklogTaskRequestTypeDef

update_goal#

Update an existing goal.

Type annotations and code completion for boto3.client("devops-agent").update_goal method. boto3 documentation

# update_goal method definition

def update_goal(
    self,
    *,
    agentSpaceId: str,
    goalId: str,
    evaluationSchedule: GoalScheduleInputTypeDef = ...,  # (1)
    clientToken: str = ...,
) -> UpdateGoalResponseTypeDef:  # (2)
    ...
  1. See GoalScheduleInputTypeDef
  2. See UpdateGoalResponseTypeDef
# update_goal method usage example with argument unpacking

kwargs: UpdateGoalRequestTypeDef = {  # (1)
    "agentSpaceId": ...,
    "goalId": ...,
}

parent.update_goal(**kwargs)
  1. See UpdateGoalRequestTypeDef

update_operator_app_idp_config#

Update the external Identity Provider configuration for the Operator App.

Type annotations and code completion for boto3.client("devops-agent").update_operator_app_idp_config method. boto3 documentation

# update_operator_app_idp_config method definition

def update_operator_app_idp_config(
    self,
    *,
    agentSpaceId: str,
    idpClientSecret: str = ...,
) -> UpdateOperatorAppIdpConfigOutputTypeDef:  # (1)
    ...
  1. See UpdateOperatorAppIdpConfigOutputTypeDef
# update_operator_app_idp_config method usage example with argument unpacking

kwargs: UpdateOperatorAppIdpConfigInputTypeDef = {  # (1)
    "agentSpaceId": ...,
}

parent.update_operator_app_idp_config(**kwargs)
  1. See UpdateOperatorAppIdpConfigInputTypeDef

update_private_connection_certificate#

Updates the certificate associated with a Private Connection.

Type annotations and code completion for boto3.client("devops-agent").update_private_connection_certificate method. boto3 documentation

# update_private_connection_certificate method definition

def update_private_connection_certificate(
    self,
    *,
    name: str,
    certificate: str,
) -> UpdatePrivateConnectionCertificateOutputTypeDef:  # (1)
    ...
  1. See UpdatePrivateConnectionCertificateOutputTypeDef
# update_private_connection_certificate method usage example with argument unpacking

kwargs: UpdatePrivateConnectionCertificateInputTypeDef = {  # (1)
    "name": ...,
    "certificate": ...,
}

parent.update_private_connection_certificate(**kwargs)
  1. See UpdatePrivateConnectionCertificateInputTypeDef

update_recommendation#

Updates an existing recommendation with new content, status, or metadata.

Type annotations and code completion for boto3.client("devops-agent").update_recommendation method. boto3 documentation

# update_recommendation method definition

def update_recommendation(
    self,
    *,
    agentSpaceId: str,
    recommendationId: str,
    status: RecommendationStatusType = ...,  # (1)
    additionalContext: str = ...,
    clientToken: str = ...,
) -> UpdateRecommendationResponseTypeDef:  # (2)
    ...
  1. See RecommendationStatusType
  2. See UpdateRecommendationResponseTypeDef
# update_recommendation method usage example with argument unpacking

kwargs: UpdateRecommendationRequestTypeDef = {  # (1)
    "agentSpaceId": ...,
    "recommendationId": ...,
}

parent.update_recommendation(**kwargs)
  1. See UpdateRecommendationRequestTypeDef

validate_aws_associations#

Validates an aws association and set status and returns a 204 No Content response on success.

Type annotations and code completion for boto3.client("devops-agent").validate_aws_associations method. boto3 documentation

# validate_aws_associations method definition

def validate_aws_associations(
    self,
    *,
    agentSpaceId: str,
) -> dict[str, Any]:
    ...
# validate_aws_associations method usage example with argument unpacking

kwargs: ValidateAwsAssociationsInputTypeDef = {  # (1)
    "agentSpaceId": ...,
}

parent.validate_aws_associations(**kwargs)
  1. See ValidateAwsAssociationsInputTypeDef

get_paginator#

Type annotations and code completion for boto3.client("devops-agent").get_paginator method with overloads.