AgentRegistryControlClient

Index > AgentRegistryControl > AgentRegistryControlClient

Auto-generated documentation for AgentRegistryControl type annotations stubs module mypy-boto3-agent-registry-control.

AgentRegistryControlClient

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

# AgentRegistryControlClient usage example

from boto3.session import Session
from mypy_boto3_agent_registry_control.client import AgentRegistryControlClient

def get_agent-registry-control_client() -> AgentRegistryControlClient:
    return Session().client("agent-registry-control")

Exceptions

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

# Exceptions.exceptions usage example

client = boto3.client("agent-registry-control")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_agent_registry_control.client import Exceptions

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

Methods

can_paginate

Type annotations and code completion for boto3.client("agent-registry-control").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("agent-registry-control").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:
    ...

create_registry

Creates a new registry, a catalog that organizes registry records and defines their discovery authorization and record approval behavior.

Type annotations and code completion for boto3.client("agent-registry-control").create_registry method. boto3 documentation

# create_registry method definition

def create_registry(
    self,
    *,
    name: str,
    description: str = ...,
    discoveryConfiguration: DiscoveryConfigurationUnionTypeDef = ...,  # (1)
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
    approvalConfiguration: ApprovalConfigurationUnionTypeDef = ...,  # (2)
) -> CreateRegistryResponseTypeDef:  # (3)
    ...

1. See DiscoveryConfigurationUnionTypeDef
2. See ApprovalConfigurationUnionTypeDef
3. See CreateRegistryResponseTypeDef

# create_registry method usage example with argument unpacking

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

parent.create_registry(**kwargs)

1. See CreateRegistryRequestTypeDef

create_registry_record

Creates a registry record within a registry.

Type annotations and code completion for boto3.client("agent-registry-control").create_registry_record method. boto3 documentation

# create_registry_record method definition

def create_registry_record(
    self,
    *,
    registryId: str,
    name: str,
    recordType: RecordTypeType,  # (1)
    descriptors: DescriptorsUnionTypeDef,  # (2)
    displayName: str = ...,
    description: str = ...,
    recordVersion: str = ...,
    clientToken: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateRegistryRecordResponseTypeDef:  # (3)
    ...

1. See RecordTypeType
2. See DescriptorsUnionTypeDef
3. See CreateRegistryRecordResponseTypeDef

# create_registry_record method usage example with argument unpacking

kwargs: CreateRegistryRecordRequestTypeDef = {  # (1)
    "registryId": ...,
    "name": ...,
    "recordType": ...,
    "descriptors": ...,
}

parent.create_registry_record(**kwargs)

1. See CreateRegistryRecordRequestTypeDef

delete_registry

Deletes a registry.

Type annotations and code completion for boto3.client("agent-registry-control").delete_registry method. boto3 documentation

# delete_registry method definition

def delete_registry(
    self,
    *,
    registryId: str,
) -> DeleteRegistryResponseTypeDef:  # (1)
    ...

1. See DeleteRegistryResponseTypeDef

# delete_registry method usage example with argument unpacking

kwargs: DeleteRegistryRequestTypeDef = {  # (1)
    "registryId": ...,
}

parent.delete_registry(**kwargs)

1. See DeleteRegistryRequestTypeDef

delete_registry_record

Deletes a registry record.

Type annotations and code completion for boto3.client("agent-registry-control").delete_registry_record method. boto3 documentation

# delete_registry_record method definition

def delete_registry_record(
    self,
    *,
    registryId: str,
    recordId: str,
) -> dict[str, Any]:
    ...

# delete_registry_record method usage example with argument unpacking

kwargs: DeleteRegistryRecordRequestTypeDef = {  # (1)
    "registryId": ...,
    "recordId": ...,
}

parent.delete_registry_record(**kwargs)

1. See DeleteRegistryRecordRequestTypeDef

get_registry

Gets a registry by identifier (ARN or ID).

Type annotations and code completion for boto3.client("agent-registry-control").get_registry method. boto3 documentation

# get_registry method definition

def get_registry(
    self,
    *,
    registryId: str,
) -> GetRegistryResponseTypeDef:  # (1)
    ...

1. See GetRegistryResponseTypeDef

# get_registry method usage example with argument unpacking

kwargs: GetRegistryRequestTypeDef = {  # (1)
    "registryId": ...,
}

parent.get_registry(**kwargs)

1. See GetRegistryRequestTypeDef

get_registry_record

Retrieves the details of a registry record.

Type annotations and code completion for boto3.client("agent-registry-control").get_registry_record method. boto3 documentation

# get_registry_record method definition

def get_registry_record(
    self,
    *,
    registryId: str,
    recordId: str,
) -> GetRegistryRecordResponseTypeDef:  # (1)
    ...

1. See GetRegistryRecordResponseTypeDef

# get_registry_record method usage example with argument unpacking

kwargs: GetRegistryRecordRequestTypeDef = {  # (1)
    "registryId": ...,
    "recordId": ...,
}

parent.get_registry_record(**kwargs)

1. See GetRegistryRecordRequestTypeDef

list_registries

Lists the registries in the caller's account and Region, with optional filtering by status and discovery authorizer type.

Type annotations and code completion for boto3.client("agent-registry-control").list_registries method. boto3 documentation

# list_registries method definition

def list_registries(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
    filters: Sequence[RegistryFilterTypeDef] = ...,  # (1)
) -> ListRegistriesResponseTypeDef:  # (2)
    ...

1. See Sequence[RegistryFilterTypeDef]
2. See ListRegistriesResponseTypeDef

# list_registries method usage example with argument unpacking

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

parent.list_registries(**kwargs)

1. See ListRegistriesRequestTypeDef

list_registry_records

Lists the registry records within a registry, with optional filtering by name, status, and record type.

Type annotations and code completion for boto3.client("agent-registry-control").list_registry_records method. boto3 documentation

# list_registry_records method definition

def list_registry_records(
    self,
    *,
    registryId: str,
    maxResults: int = ...,
    nextToken: str = ...,
    filters: Sequence[RegistryRecordFilterTypeDef] = ...,  # (1)
) -> ListRegistryRecordsResponseTypeDef:  # (2)
    ...

1. See Sequence[RegistryRecordFilterTypeDef]
2. See ListRegistryRecordsResponseTypeDef

# list_registry_records method usage example with argument unpacking

kwargs: ListRegistryRecordsRequestTypeDef = {  # (1)
    "registryId": ...,
}

parent.list_registry_records(**kwargs)

1. See ListRegistryRecordsRequestTypeDef

list_tags_for_resource

List the tags on a resource.

Type annotations and code completion for boto3.client("agent-registry-control").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

submit_registry_record_for_approval

Submits a DRAFT registry record for approval, moving it into the registry's approval workflow.

Type annotations and code completion for boto3.client("agent-registry-control").submit_registry_record_for_approval method. boto3 documentation

# submit_registry_record_for_approval method definition

def submit_registry_record_for_approval(
    self,
    *,
    registryId: str,
    recordId: str,
) -> SubmitRegistryRecordForApprovalResponseTypeDef:  # (1)
    ...

1. See SubmitRegistryRecordForApprovalResponseTypeDef

# submit_registry_record_for_approval method usage example with argument unpacking

kwargs: SubmitRegistryRecordForApprovalRequestTypeDef = {  # (1)
    "registryId": ...,
    "recordId": ...,
}

parent.submit_registry_record_for_approval(**kwargs)

1. See SubmitRegistryRecordForApprovalRequestTypeDef

tag_resource

Tag a resource with key-value pairs.

Type annotations and code completion for boto3.client("agent-registry-control").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

Remove tags from a resource by key.

Type annotations and code completion for boto3.client("agent-registry-control").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_registry

Updates an existing registry.

Type annotations and code completion for boto3.client("agent-registry-control").update_registry method. boto3 documentation

# update_registry method definition

def update_registry(
    self,
    *,
    registryId: str,
    name: str = ...,
    description: UpdatedDescriptionTypeDef = ...,  # (1)
    discoveryConfiguration: UpdatedDiscoveryConfigurationTypeDef = ...,  # (2)
    approvalConfiguration: UpdatedApprovalConfigurationTypeDef = ...,  # (3)
) -> UpdateRegistryResponseTypeDef:  # (4)
    ...

1. See UpdatedDescriptionTypeDef
2. See UpdatedDiscoveryConfigurationTypeDef
3. See UpdatedApprovalConfigurationTypeDef
4. See UpdateRegistryResponseTypeDef

# update_registry method usage example with argument unpacking

kwargs: UpdateRegistryRequestTypeDef = {  # (1)
    "registryId": ...,
}

parent.update_registry(**kwargs)

1. See UpdateRegistryRequestTypeDef

update_registry_record

Updates a registry record.

Type annotations and code completion for boto3.client("agent-registry-control").update_registry_record method. boto3 documentation

# update_registry_record method definition

def update_registry_record(
    self,
    *,
    registryId: str,
    recordId: str,
    name: str = ...,
    displayName: UpdatedDisplayNameTypeDef = ...,  # (1)
    description: UpdatedDescriptionTypeDef = ...,  # (2)
    recordType: RecordTypeType = ...,  # (3)
    descriptors: UpdatedDescriptorsTypeDef = ...,  # (4)
    recordVersion: str = ...,
    triggerSynchronization: bool = ...,
) -> UpdateRegistryRecordResponseTypeDef:  # (5)
    ...

1. See UpdatedDisplayNameTypeDef
2. See UpdatedDescriptionTypeDef
3. See RecordTypeType
4. See UpdatedDescriptorsTypeDef
5. See UpdateRegistryRecordResponseTypeDef

# update_registry_record method usage example with argument unpacking

kwargs: UpdateRegistryRecordRequestTypeDef = {  # (1)
    "registryId": ...,
    "recordId": ...,
}

parent.update_registry_record(**kwargs)

1. See UpdateRegistryRecordRequestTypeDef

update_registry_record_status

Updates the status of a registry record as part of the registry's curation workflow, for example to approve or reject a record that is pending approval, or to deprecate an approved record so that it is no longer discoverable.

Type annotations and code completion for boto3.client("agent-registry-control").update_registry_record_status method. boto3 documentation

# update_registry_record_status method definition

def update_registry_record_status(
    self,
    *,
    registryId: str,
    recordId: str,
    status: RegistryRecordStatusType,  # (1)
    statusReason: str,
) -> UpdateRegistryRecordStatusResponseTypeDef:  # (2)
    ...

1. See RegistryRecordStatusType
2. See UpdateRegistryRecordStatusResponseTypeDef

# update_registry_record_status method usage example with argument unpacking

kwargs: UpdateRegistryRecordStatusRequestTypeDef = {  # (1)
    "registryId": ...,
    "recordId": ...,
    "status": ...,
    "statusReason": ...,
}

parent.update_registry_record_status(**kwargs)

1. See UpdateRegistryRecordStatusRequestTypeDef

get_paginator

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

• client.get_paginator("list_registries") -> ListRegistriesPaginator
• client.get_paginator("list_registry_records") -> ListRegistryRecordsPaginator

get_waiter

Type annotations and code completion for boto3.client("agent-registry-control").get_waiter method with overloads.

• client.get_waiter("registry_ready") -> RegistryReadyWaiter
• client.get_waiter("registry_record_approved") -> RegistryRecordApprovedWaiter