Service Catalog Appregistry

This page documents function available when using the Service_Catalog_Appregistry module, created with @service Service_Catalog_Appregistry.

Index

Documentation

Main.Service_Catalog_Appregistry.associate_attribute_groupMethod
associate_attribute_group(application, attribute_group)
associate_attribute_group(application, attribute_group, params::Dict{String,<:Any})

Associates an attribute group with an application to augment the application's metadata with the group's attributes. This feature enables applications to be described with user-defined details that are machine-readable, such as third-party integrations.

Arguments

  • application: The name or ID of the application.
  • attribute_group: The name or ID of the attribute group that holds the attributes to describe the application.
source
Main.Service_Catalog_Appregistry.associate_resourceMethod
associate_resource(application, resource, resource_type)
associate_resource(application, resource, resource_type, params::Dict{String,<:Any})

Associates a resource with an application. Both the resource and the application can be specified either by ID or name.

Arguments

  • application: The name or ID of the application.
  • resource: The name or ID of the resource of which the application will be associated.
  • resource_type: The type of resource of which the application will be associated.
source
Main.Service_Catalog_Appregistry.create_applicationMethod
create_application(client_token, name)
create_application(client_token, name, params::Dict{String,<:Any})

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

Arguments

  • client_token: A unique identifier that you provide to ensure idempotency. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails.
  • name: The name of the application. The name must be unique in the region in which you are creating the application.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": The description of the application.
  • "tags": Key-value pairs you can use to associate with the application.
source
Main.Service_Catalog_Appregistry.create_attribute_groupMethod
create_attribute_group(attributes, client_token, name)
create_attribute_group(attributes, client_token, name, params::Dict{String,<:Any})

Creates a new attribute group as a container for user-defined attributes. This feature enables users to have full control over their cloud application's metadata in a rich machine-readable format to facilitate integration with automated workflows and third-party tools.

Arguments

  • attributes: A JSON string in the form of nested key-value pairs that represent the attributes in the group and describes an application and its components.
  • client_token: A unique identifier that you provide to ensure idempotency. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, the retry fails.
  • name: The name of the attribute group.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": The description of the attribute group that the user provides.
  • "tags": Key-value pairs you can use to associate with the attribute group.
source
Main.Service_Catalog_Appregistry.delete_applicationMethod
delete_application(application)
delete_application(application, params::Dict{String,<:Any})

Deletes an application that is specified either by its application ID or name. All associated attribute groups and resources must be disassociated from it before deleting an application.

Arguments

  • application: The name or ID of the application.
source
Main.Service_Catalog_Appregistry.delete_attribute_groupMethod
delete_attribute_group(attribute_group)
delete_attribute_group(attribute_group, params::Dict{String,<:Any})

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

Arguments

  • attribute_group: The name or ID of the attribute group that holds the attributes to describe the application.
source
Main.Service_Catalog_Appregistry.disassociate_attribute_groupMethod
disassociate_attribute_group(application, attribute_group)
disassociate_attribute_group(application, attribute_group, params::Dict{String,<:Any})

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

Arguments

  • application: The name or ID of the application.
  • attribute_group: The name or ID of the attribute group that holds the attributes to describe the application.
source
Main.Service_Catalog_Appregistry.disassociate_resourceMethod
disassociate_resource(application, resource, resource_type)
disassociate_resource(application, resource, resource_type, params::Dict{String,<:Any})

Disassociates a resource from application. Both the resource and the application can be specified either by ID or name.

Arguments

  • application: The name or ID of the application.
  • resource: The name or ID of the resource.
  • resource_type: The type of the resource that is being disassociated.
source
Main.Service_Catalog_Appregistry.get_applicationMethod
get_application(application)
get_application(application, params::Dict{String,<:Any})

Retrieves metadata information about one of your applications. The application can be specified either by its unique ID or by its name (which is unique within one account in one region at a given point in time). Specify by ID in automated workflows if you want to make sure that the exact same application is returned or a ResourceNotFoundException is thrown, avoiding the ABA addressing problem.

Arguments

  • application: The name or ID of the application.
source
Main.Service_Catalog_Appregistry.get_attribute_groupMethod
get_attribute_group(attribute_group)
get_attribute_group(attribute_group, params::Dict{String,<:Any})

Retrieves an attribute group, either by its name or its ID. The attribute group can be specified either by its unique ID or by its name.

Arguments

  • attribute_group: The name or ID of the attribute group that holds the attributes to describe the application.
source
Main.Service_Catalog_Appregistry.list_applicationsMethod
list_applications()
list_applications(params::Dict{String,<:Any})

Retrieves a list of all of your applications. Results are paginated.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The upper bound of the number of results to return (cannot exceed 25). If this parameter is omitted, it defaults to 25. This value is optional.
  • "nextToken": The token to use to get the next page of results after a previous API call.
source
Main.Service_Catalog_Appregistry.list_associated_attribute_groupsMethod
list_associated_attribute_groups(application)
list_associated_attribute_groups(application, params::Dict{String,<:Any})

Lists all attribute groups that are associated with specified application. Results are paginated.

Arguments

  • application: The name or ID of the application.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The upper bound of the number of results to return (cannot exceed 25). If this parameter is omitted, it defaults to 25. This value is optional.
  • "nextToken": The token to use to get the next page of results after a previous API call.
source
Main.Service_Catalog_Appregistry.list_associated_resourcesMethod
list_associated_resources(application)
list_associated_resources(application, params::Dict{String,<:Any})

Lists all resources that are associated with specified application. Results are paginated.

Arguments

  • application: The name or ID of the application.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The upper bound of the number of results to return (cannot exceed 25). If this parameter is omitted, it defaults to 25. This value is optional.
  • "nextToken": The token to use to get the next page of results after a previous API call.
source
Main.Service_Catalog_Appregistry.list_attribute_groupsMethod
list_attribute_groups()
list_attribute_groups(params::Dict{String,<:Any})

Lists all attribute groups which you have access to. Results are paginated.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The upper bound of the number of results to return (cannot exceed 25). If this parameter is omitted, it defaults to 25. This value is optional.
  • "nextToken": The token to use to get the next page of results after a previous API call.
source
Main.Service_Catalog_Appregistry.sync_resourceMethod
sync_resource(resource, resource_type)
sync_resource(resource, resource_type, params::Dict{String,<:Any})

Syncs the resource with what is currently recorded in App registry. Specifically, the resource’s App registry system tags are synced with its associated application. The resource is removed if it is not associated with the application. The caller must have permissions to read and update the resource.

Arguments

  • resource: An entity you can work with and specify with a name or ID. Examples include an Amazon EC2 instance, an AWS CloudFormation stack, or an Amazon S3 bucket.
  • resource_type: The type of resource of which the application will be associated.
source
Main.Service_Catalog_Appregistry.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Assigns one or more tags (key-value pairs) to the specified resource. Each tag consists of a key and an optional value. If a tag with the same key is already associated with the resource, this action updates its value. This operation returns an empty response if the call was successful.

Arguments

  • resource_arn: The Amazon resource name (ARN) that specifies the resource.
  • tags: The new or modified tags for the resource.
source
Main.Service_Catalog_Appregistry.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Removes tags from a resource. This operation returns an empty response if the call was successful.

Arguments

  • resource_arn: The Amazon resource name (ARN) that specifies the resource.
  • tag_keys: A list of the tag keys to remove from the specified resource.
source
Main.Service_Catalog_Appregistry.update_applicationMethod
update_application(application)
update_application(application, params::Dict{String,<:Any})

Updates an existing application with new attributes.

Arguments

  • application: The name or ID of the application that will be updated.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": The new description of the application.
  • "name": The new name of the application. The name must be unique in the region in which you are updating the application.
source
Main.Service_Catalog_Appregistry.update_attribute_groupMethod
update_attribute_group(attribute_group)
update_attribute_group(attribute_group, params::Dict{String,<:Any})

Updates an existing attribute group with new details.

Arguments

  • attribute_group: The name or ID of the attribute group that holds the attributes to describe the application.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "attributes": A JSON string in the form of nested key-value pairs that represent the attributes in the group and describes an application and its components.
  • "description": The description of the attribute group that the user provides.
  • "name": The new name of the attribute group. The name must be unique in the region in which you are updating the attribute group.
source