Skip to content

AppRegistryClient#

Index > AppRegistry > AppRegistryClient

Auto-generated documentation for AppRegistry type annotations stubs module mypy-boto3-servicecatalog-appregistry.

AppRegistryClient#

Type annotations and code completion for boto3.client("servicecatalog-appregistry"). boto3 documentation

# AppRegistryClient usage example

from boto3.session import Session
from mypy_boto3_servicecatalog_appregistry.client import AppRegistryClient

def get_servicecatalog-appregistry_client() -> AppRegistryClient:
    return Session().client("servicecatalog-appregistry")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("servicecatalog-appregistry")

try:
    do_something(client)
except (
    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_servicecatalog_appregistry.client import Exceptions

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

Methods#

associate_attribute_group#

Associates an attribute group with an application to augment the application's metadata with the group's attributes.

Type annotations and code completion for boto3.client("servicecatalog-appregistry").associate_attribute_group method. boto3 documentation

# associate_attribute_group method definition

def associate_attribute_group(
    self,
    *,
    application: str,
    attributeGroup: str,
) -> AssociateAttributeGroupResponseTypeDef:  # (1)
    ...
  1. See AssociateAttributeGroupResponseTypeDef 
# associate_attribute_group method usage example with argument unpacking

kwargs: AssociateAttributeGroupRequestRequestTypeDef = {  # (1)
    "application": ...,
    "attributeGroup": ...,
}

parent.associate_attribute_group(**kwargs)
  1. See AssociateAttributeGroupRequestRequestTypeDef

associate_resource#

Associates a resource with an application.

Type annotations and code completion for boto3.client("servicecatalog-appregistry").associate_resource method. boto3 documentation

# associate_resource method definition

def associate_resource(
    self,
    *,
    application: str,
    resourceType: ResourceTypeType,  # (1)
    resource: str,
    options: Sequence[AssociationOptionType] = ...,  # (2)
) -> AssociateResourceResponseTypeDef:  # (3)
    ...
  1. See ResourceTypeType
  2. See AssociationOptionType
  3. See AssociateResourceResponseTypeDef 
# associate_resource method usage example with argument unpacking

kwargs: AssociateResourceRequestRequestTypeDef = {  # (1)
    "application": ...,
    "resourceType": ...,
    "resource": ...,
}

parent.associate_resource(**kwargs)
  1. See AssociateResourceRequestRequestTypeDef

can_paginate#

Check if an operation can be paginated.

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

# can_paginate method definition

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

close#

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("servicecatalog-appregistry").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_application#

Creates a new application that is the top-level node in a hierarchy of related cloud resource abstractions.

Type annotations and code completion for boto3.client("servicecatalog-appregistry").create_application method. boto3 documentation

# create_application method definition

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

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

parent.create_application(**kwargs)
  1. See CreateApplicationRequestRequestTypeDef

create_attribute_group#

Creates a new attribute group as a container for user-defined attributes.

Type annotations and code completion for boto3.client("servicecatalog-appregistry").create_attribute_group method. boto3 documentation

# create_attribute_group method definition

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

kwargs: CreateAttributeGroupRequestRequestTypeDef = {  # (1)
    "name": ...,
    "attributes": ...,
    "clientToken": ...,
}

parent.create_attribute_group(**kwargs)
  1. See CreateAttributeGroupRequestRequestTypeDef

delete_application#

Deletes an application that is specified either by its application ID, name, or ARN.

Type annotations and code completion for boto3.client("servicecatalog-appregistry").delete_application method. boto3 documentation

# delete_application method definition

def delete_application(
    self,
    *,
    application: str,
) -> DeleteApplicationResponseTypeDef:  # (1)
    ...
  1. See DeleteApplicationResponseTypeDef 
# delete_application method usage example with argument unpacking

kwargs: DeleteApplicationRequestRequestTypeDef = {  # (1)
    "application": ...,
}

parent.delete_application(**kwargs)
  1. See DeleteApplicationRequestRequestTypeDef

delete_attribute_group#

Deletes an attribute group, specified either by its attribute group ID, name, or ARN.

Type annotations and code completion for boto3.client("servicecatalog-appregistry").delete_attribute_group method. boto3 documentation

# delete_attribute_group method definition

def delete_attribute_group(
    self,
    *,
    attributeGroup: str,
) -> DeleteAttributeGroupResponseTypeDef:  # (1)
    ...
  1. See DeleteAttributeGroupResponseTypeDef 
# delete_attribute_group method usage example with argument unpacking

kwargs: DeleteAttributeGroupRequestRequestTypeDef = {  # (1)
    "attributeGroup": ...,
}

parent.delete_attribute_group(**kwargs)
  1. See DeleteAttributeGroupRequestRequestTypeDef

disassociate_attribute_group#

Disassociates an attribute group from an application to remove the extra attributes contained in the attribute group from the application's metadata.

Type annotations and code completion for boto3.client("servicecatalog-appregistry").disassociate_attribute_group method. boto3 documentation

# disassociate_attribute_group method definition

def disassociate_attribute_group(
    self,
    *,
    application: str,
    attributeGroup: str,
) -> DisassociateAttributeGroupResponseTypeDef:  # (1)
    ...
  1. See DisassociateAttributeGroupResponseTypeDef 
# disassociate_attribute_group method usage example with argument unpacking

kwargs: DisassociateAttributeGroupRequestRequestTypeDef = {  # (1)
    "application": ...,
    "attributeGroup": ...,
}

parent.disassociate_attribute_group(**kwargs)
  1. See DisassociateAttributeGroupRequestRequestTypeDef

disassociate_resource#

Disassociates a resource from application.

Type annotations and code completion for boto3.client("servicecatalog-appregistry").disassociate_resource method. boto3 documentation

# disassociate_resource method definition

def disassociate_resource(
    self,
    *,
    application: str,
    resourceType: ResourceTypeType,  # (1)
    resource: str,
) -> DisassociateResourceResponseTypeDef:  # (2)
    ...
  1. See ResourceTypeType
  2. See DisassociateResourceResponseTypeDef 
# disassociate_resource method usage example with argument unpacking

kwargs: DisassociateResourceRequestRequestTypeDef = {  # (1)
    "application": ...,
    "resourceType": ...,
    "resource": ...,
}

parent.disassociate_resource(**kwargs)
  1. See DisassociateResourceRequestRequestTypeDef

generate_presigned_url#

Generate a presigned url given a client, its method, and arguments.

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

get_application#

Retrieves metadata information about one of your applications.

Type annotations and code completion for boto3.client("servicecatalog-appregistry").get_application method. boto3 documentation

# get_application method definition

def get_application(
    self,
    *,
    application: str,
) -> GetApplicationResponseTypeDef:  # (1)
    ...
  1. See GetApplicationResponseTypeDef 
# get_application method usage example with argument unpacking

kwargs: GetApplicationRequestRequestTypeDef = {  # (1)
    "application": ...,
}

parent.get_application(**kwargs)
  1. See GetApplicationRequestRequestTypeDef

get_associated_resource#

Gets the resource associated with the application.

Type annotations and code completion for boto3.client("servicecatalog-appregistry").get_associated_resource method. boto3 documentation

# get_associated_resource method definition

def get_associated_resource(
    self,
    *,
    application: str,
    resourceType: ResourceTypeType,  # (1)
    resource: str,
    nextToken: str = ...,
    resourceTagStatus: Sequence[ResourceItemStatusType] = ...,  # (2)
    maxResults: int = ...,
) -> GetAssociatedResourceResponseTypeDef:  # (3)
    ...
  1. See ResourceTypeType
  2. See ResourceItemStatusType
  3. See GetAssociatedResourceResponseTypeDef 
# get_associated_resource method usage example with argument unpacking

kwargs: GetAssociatedResourceRequestRequestTypeDef = {  # (1)
    "application": ...,
    "resourceType": ...,
    "resource": ...,
}

parent.get_associated_resource(**kwargs)
  1. See GetAssociatedResourceRequestRequestTypeDef

get_attribute_group#

Retrieves an attribute group by its ARN, ID, or name.

Type annotations and code completion for boto3.client("servicecatalog-appregistry").get_attribute_group method. boto3 documentation

# get_attribute_group method definition

def get_attribute_group(
    self,
    *,
    attributeGroup: str,
) -> GetAttributeGroupResponseTypeDef:  # (1)
    ...
  1. See GetAttributeGroupResponseTypeDef 
# get_attribute_group method usage example with argument unpacking

kwargs: GetAttributeGroupRequestRequestTypeDef = {  # (1)
    "attributeGroup": ...,
}

parent.get_attribute_group(**kwargs)
  1. See GetAttributeGroupRequestRequestTypeDef

get_configuration#

Retrieves a TagKey configuration from an account.

Type annotations and code completion for boto3.client("servicecatalog-appregistry").get_configuration method. boto3 documentation

# get_configuration method definition

def get_configuration(
    self,
) -> GetConfigurationResponseTypeDef:  # (1)
    ...
  1. See GetConfigurationResponseTypeDef

list_applications#

Retrieves a list of all of your applications.

Type annotations and code completion for boto3.client("servicecatalog-appregistry").list_applications method. boto3 documentation

# list_applications method definition

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

kwargs: ListApplicationsRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_applications(**kwargs)
  1. See ListApplicationsRequestRequestTypeDef

list_associated_attribute_groups#

Lists all attribute groups that are associated with specified application.

Type annotations and code completion for boto3.client("servicecatalog-appregistry").list_associated_attribute_groups method. boto3 documentation

# list_associated_attribute_groups method definition

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

kwargs: ListAssociatedAttributeGroupsRequestRequestTypeDef = {  # (1)
    "application": ...,
}

parent.list_associated_attribute_groups(**kwargs)
  1. See ListAssociatedAttributeGroupsRequestRequestTypeDef

list_associated_resources#

Lists all of the resources that are associated with the specified application.

Type annotations and code completion for boto3.client("servicecatalog-appregistry").list_associated_resources method. boto3 documentation

# list_associated_resources method definition

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

kwargs: ListAssociatedResourcesRequestRequestTypeDef = {  # (1)
    "application": ...,
}

parent.list_associated_resources(**kwargs)
  1. See ListAssociatedResourcesRequestRequestTypeDef

list_attribute_groups#

Lists all attribute groups which you have access to.

Type annotations and code completion for boto3.client("servicecatalog-appregistry").list_attribute_groups method. boto3 documentation

# list_attribute_groups method definition

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

kwargs: ListAttributeGroupsRequestRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_attribute_groups(**kwargs)
  1. See ListAttributeGroupsRequestRequestTypeDef

list_attribute_groups_for_application#

Lists the details of all attribute groups associated with a specific application.

Type annotations and code completion for boto3.client("servicecatalog-appregistry").list_attribute_groups_for_application method. boto3 documentation

# list_attribute_groups_for_application method definition

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

kwargs: ListAttributeGroupsForApplicationRequestRequestTypeDef = {  # (1)
    "application": ...,
}

parent.list_attribute_groups_for_application(**kwargs)
  1. See ListAttributeGroupsForApplicationRequestRequestTypeDef

list_tags_for_resource#

Lists all of the tags on the resource.

Type annotations and code completion for boto3.client("servicecatalog-appregistry").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: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

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

put_configuration#

Associates a TagKey configuration to an account.

Type annotations and code completion for boto3.client("servicecatalog-appregistry").put_configuration method. boto3 documentation

# put_configuration method definition

def put_configuration(
    self,
    *,
    configuration: AppRegistryConfigurationTypeDef,  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...
  1. See AppRegistryConfigurationTypeDef
  2. See EmptyResponseMetadataTypeDef 
# put_configuration method usage example with argument unpacking

kwargs: PutConfigurationRequestRequestTypeDef = {  # (1)
    "configuration": ...,
}

parent.put_configuration(**kwargs)
  1. See PutConfigurationRequestRequestTypeDef

sync_resource#

Syncs the resource with current AppRegistry records.

Type annotations and code completion for boto3.client("servicecatalog-appregistry").sync_resource method. boto3 documentation

# sync_resource method definition

def sync_resource(
    self,
    *,
    resourceType: ResourceTypeType,  # (1)
    resource: str,
) -> SyncResourceResponseTypeDef:  # (2)
    ...
  1. See ResourceTypeType
  2. See SyncResourceResponseTypeDef 
# sync_resource method usage example with argument unpacking

kwargs: SyncResourceRequestRequestTypeDef = {  # (1)
    "resourceType": ...,
    "resource": ...,
}

parent.sync_resource(**kwargs)
  1. See SyncResourceRequestRequestTypeDef

tag_resource#

Assigns one or more tags (key-value pairs) to the specified resource.

Type annotations and code completion for boto3.client("servicecatalog-appregistry").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: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

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

untag_resource#

Removes tags from a resource.

Type annotations and code completion for boto3.client("servicecatalog-appregistry").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: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

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

update_application#

Updates an existing application with new attributes.

Type annotations and code completion for boto3.client("servicecatalog-appregistry").update_application method. boto3 documentation

# update_application method definition

def update_application(
    self,
    *,
    application: str,
    name: str = ...,
    description: str = ...,
) -> UpdateApplicationResponseTypeDef:  # (1)
    ...
  1. See UpdateApplicationResponseTypeDef 
# update_application method usage example with argument unpacking

kwargs: UpdateApplicationRequestRequestTypeDef = {  # (1)
    "application": ...,
}

parent.update_application(**kwargs)
  1. See UpdateApplicationRequestRequestTypeDef

update_attribute_group#

Updates an existing attribute group with new details.

Type annotations and code completion for boto3.client("servicecatalog-appregistry").update_attribute_group method. boto3 documentation

# update_attribute_group method definition

def update_attribute_group(
    self,
    *,
    attributeGroup: str,
    name: str = ...,
    description: str = ...,
    attributes: str = ...,
) -> UpdateAttributeGroupResponseTypeDef:  # (1)
    ...
  1. See UpdateAttributeGroupResponseTypeDef 
# update_attribute_group method usage example with argument unpacking

kwargs: UpdateAttributeGroupRequestRequestTypeDef = {  # (1)
    "attributeGroup": ...,
}

parent.update_attribute_group(**kwargs)
  1. See UpdateAttributeGroupRequestRequestTypeDef

get_paginator#

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