AWS Service Catalog App Registry 2020-06-24
- Client: Aws\AppRegistry\AppRegistryClient
- Service ID: servicecatalog-appregistry
- Version: 2020-06-24
This page describes the parameters and results for the operations of the AWS Service Catalog App Registry (2020-06-24), and shows how to use the Aws\AppRegistry\AppRegistryClient object to call the described operations. This documentation is specific to the 2020-06-24 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- AssociateAttributeGroup ( array $params = [] )
Associates an attribute group with an application to augment the application's metadata with the group's attributes.
- AssociateResource ( array $params = [] )
Associates a resource with an application.
- CreateApplication ( array $params = [] )
Creates a new application that is the top-level node in a hierarchy of related cloud resource abstractions.
- CreateAttributeGroup ( array $params = [] )
Creates a new attribute group as a container for user-defined attributes.
- DeleteApplication ( array $params = [] )
Deletes an application that is specified either by its application ID, name, or ARN.
- DeleteAttributeGroup ( array $params = [] )
Deletes an attribute group, specified either by its attribute group ID, name, or ARN.
- DisassociateAttributeGroup ( array $params = [] )
Disassociates an attribute group from an application to remove the extra attributes contained in the attribute group from the application's metadata.
- DisassociateResource ( array $params = [] )
Disassociates a resource from application.
- GetApplication ( array $params = [] )
Retrieves metadata information about one of your applications.
- GetAssociatedResource ( array $params = [] )
Gets the resource associated with the application.
- GetAttributeGroup ( array $params = [] )
Retrieves an attribute group by its ARN, ID, or name.
- GetConfiguration ( array $params = [] )
Retrieves a TagKey configuration from an account.
- ListApplications ( array $params = [] )
Retrieves a list of all of your applications.
- ListAssociatedAttributeGroups ( array $params = [] )
Lists all attribute groups that are associated with specified application.
- ListAssociatedResources ( array $params = [] )
Lists all of the resources that are associated with the specified application.
- ListAttributeGroups ( array $params = [] )
Lists all attribute groups which you have access to.
- ListAttributeGroupsForApplication ( array $params = [] )
Lists the details of all attribute groups associated with a specific application.
- ListTagsForResource ( array $params = [] )
Lists all of the tags on the resource.
- PutConfiguration ( array $params = [] )
Associates a TagKey configuration to an account.
- SyncResource ( array $params = [] )
Syncs the resource with current AppRegistry records.
- TagResource ( array $params = [] )
Assigns one or more tags (key-value pairs) to the specified resource.
- UntagResource ( array $params = [] )
Removes tags from a resource.
- UpdateApplication ( array $params = [] )
Updates an existing application with new attributes.
- UpdateAttributeGroup ( array $params = [] )
Updates an existing attribute group with new details.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
AssociateAttributeGroup
$result = $client->associateAttributeGroup([/* ... */]); $promise = $client->associateAttributeGroupAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->associateAttributeGroup([
'application' => '<string>', // REQUIRED
'attributeGroup' => '<string>', // REQUIRED
]);
Parameter Details
Members
- application
-
- Required: Yes
- Type: string
The name, ID, or ARN of the application.
- attributeGroup
-
- Required: Yes
- Type: string
The name, ID, or ARN of the attribute group that holds the attributes to describe the application.
Result Syntax
[
'applicationArn' => '<string>',
'attributeGroupArn' => '<string>',
]
Result Details
Members
- applicationArn
-
- Type: string
The Amazon resource name (ARN) of the application that was augmented with attributes.
- attributeGroupArn
-
- Type: string
The Amazon resource name (ARN) of the attribute group that contains the application's new attributes.
Errors
-
The specified resource does not exist.
-
The request has invalid or missing parameters.
-
The service is experiencing internal problems.
-
ServiceQuotaExceededException:
The maximum number of resources per account has been reached.
-
There was a conflict when processing the request (for example, a resource with the given name already exists within the account).
AssociateResource
$result = $client->associateResource([/* ... */]); $promise = $client->associateResourceAsync([/* ... */]);
Associates a resource with an application. The resource can be specified by its ARN or name. The application can be specified by ARN, ID, or name.
Minimum permissions
You must have the following permissions to associate a resource using the OPTIONS parameter set to APPLY_APPLICATION_TAG.
-
tag:GetResources -
tag:TagResources
You must also have these additional permissions if you don't use the AWSServiceCatalogAppRegistryFullAccess policy. For more information, see AWSServiceCatalogAppRegistryFullAccess in the AppRegistry Administrator Guide.
-
resource-groups:DisassociateResource -
cloudformation:UpdateStack -
cloudformation:DescribeStacks
In addition, you must have the tagging permission defined by the Amazon Web Services service that creates the resource. For more information, see TagResources in the Resource Groups Tagging API Reference.
Parameter Syntax
$result = $client->associateResource([
'application' => '<string>', // REQUIRED
'options' => ['<string>', ...],
'resource' => '<string>', // REQUIRED
'resourceType' => 'CFN_STACK|RESOURCE_TAG_VALUE', // REQUIRED
]);
Parameter Details
Members
- application
-
- Required: Yes
- Type: string
The name, ID, or ARN of the application.
- options
-
- Type: Array of strings
Determines whether an application tag is applied or skipped.
- resource
-
- Required: Yes
- Type: string
The name or ID of the resource of which the application will be associated.
- resourceType
-
- Required: Yes
- Type: string
The type of resource of which the application will be associated.
Result Syntax
[
'applicationArn' => '<string>',
'options' => ['<string>', ...],
'resourceArn' => '<string>',
]
Result Details
Members
- applicationArn
-
- Type: string
The Amazon resource name (ARN) of the application that was augmented with attributes.
- options
-
- Type: Array of strings
Determines whether an application tag is applied or skipped.
- resourceArn
-
- Type: string
The Amazon resource name (ARN) that specifies the resource.
Errors
-
The specified resource does not exist.
-
The service is experiencing internal problems.
-
ServiceQuotaExceededException:
The maximum number of resources per account has been reached.
-
There was a conflict when processing the request (for example, a resource with the given name already exists within the account).
-
The request has invalid or missing parameters.
-
The maximum number of API requests has been exceeded.
CreateApplication
$result = $client->createApplication([/* ... */]); $promise = $client->createApplicationAsync([/* ... */]);
Creates a new application that is the top-level node in a hierarchy of related cloud resource abstractions.
Parameter Syntax
$result = $client->createApplication([
'clientToken' => '<string>', // REQUIRED
'description' => '<string>',
'name' => '<string>', // REQUIRED
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- clientToken
-
- Required: Yes
- Type: string
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.
- description
-
- Type: string
The description of the application.
- name
-
- Required: Yes
- Type: string
The name of the application. The name must be unique in the region in which you are creating the application.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Key-value pairs you can use to associate with the application.
Result Syntax
[
'application' => [
'applicationTag' => ['<string>', ...],
'arn' => '<string>',
'creationTime' => <DateTime>,
'description' => '<string>',
'id' => '<string>',
'lastUpdateTime' => <DateTime>,
'name' => '<string>',
'tags' => ['<string>', ...],
],
]
Result Details
Members
- application
-
- Type: Application structure
Information about the application.
Errors
-
ServiceQuotaExceededException:
The maximum number of resources per account has been reached.
-
There was a conflict when processing the request (for example, a resource with the given name already exists within the account).
-
The service is experiencing internal problems.
-
The request has invalid or missing parameters.
-
The maximum number of API requests has been exceeded.
CreateAttributeGroup
$result = $client->createAttributeGroup([/* ... */]); $promise = $client->createAttributeGroupAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->createAttributeGroup([
'attributes' => '<string>', // REQUIRED
'clientToken' => '<string>', // REQUIRED
'description' => '<string>',
'name' => '<string>', // REQUIRED
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- attributes
-
- Required: Yes
- Type: string
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.
- clientToken
-
- Required: Yes
- Type: string
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.
- description
-
- Type: string
The description of the attribute group that the user provides.
- name
-
- Required: Yes
- Type: string
The name of the attribute group.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Key-value pairs you can use to associate with the attribute group.
Result Syntax
[
'attributeGroup' => [
'arn' => '<string>',
'creationTime' => <DateTime>,
'description' => '<string>',
'id' => '<string>',
'lastUpdateTime' => <DateTime>,
'name' => '<string>',
'tags' => ['<string>', ...],
],
]
Result Details
Members
- attributeGroup
-
- Type: AttributeGroup structure
Information about the attribute group.
Errors
-
ServiceQuotaExceededException:
The maximum number of resources per account has been reached.
-
There was a conflict when processing the request (for example, a resource with the given name already exists within the account).
-
The request has invalid or missing parameters.
-
The service is experiencing internal problems.
DeleteApplication
$result = $client->deleteApplication([/* ... */]); $promise = $client->deleteApplicationAsync([/* ... */]);
Deletes an application that is specified either by its application ID, name, or ARN. All associated attribute groups and resources must be disassociated from it before deleting an application.
Parameter Syntax
$result = $client->deleteApplication([
'application' => '<string>', // REQUIRED
]);
Parameter Details
Members
- application
-
- Required: Yes
- Type: string
The name, ID, or ARN of the application.
Result Syntax
[
'application' => [
'arn' => '<string>',
'creationTime' => <DateTime>,
'description' => '<string>',
'id' => '<string>',
'lastUpdateTime' => <DateTime>,
'name' => '<string>',
],
]
Result Details
Members
- application
-
- Type: ApplicationSummary structure
Information about the deleted application.
Errors
-
The specified resource does not exist.
-
The request has invalid or missing parameters.
-
The service is experiencing internal problems.
DeleteAttributeGroup
$result = $client->deleteAttributeGroup([/* ... */]); $promise = $client->deleteAttributeGroupAsync([/* ... */]);
Deletes an attribute group, specified either by its attribute group ID, name, or ARN.
Parameter Syntax
$result = $client->deleteAttributeGroup([
'attributeGroup' => '<string>', // REQUIRED
]);
Parameter Details
Members
- attributeGroup
-
- Required: Yes
- Type: string
The name, ID, or ARN of the attribute group that holds the attributes to describe the application.
Result Syntax
[
'attributeGroup' => [
'arn' => '<string>',
'createdBy' => '<string>',
'creationTime' => <DateTime>,
'description' => '<string>',
'id' => '<string>',
'lastUpdateTime' => <DateTime>,
'name' => '<string>',
],
]
Result Details
Members
- attributeGroup
-
- Type: AttributeGroupSummary structure
Information about the deleted attribute group.
Errors
-
The specified resource does not exist.
-
The request has invalid or missing parameters.
-
The service is experiencing internal problems.
DisassociateAttributeGroup
$result = $client->disassociateAttributeGroup([/* ... */]); $promise = $client->disassociateAttributeGroupAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->disassociateAttributeGroup([
'application' => '<string>', // REQUIRED
'attributeGroup' => '<string>', // REQUIRED
]);
Parameter Details
Members
- application
-
- Required: Yes
- Type: string
The name, ID, or ARN of the application.
- attributeGroup
-
- Required: Yes
- Type: string
The name, ID, or ARN of the attribute group that holds the attributes to describe the application.
Result Syntax
[
'applicationArn' => '<string>',
'attributeGroupArn' => '<string>',
]
Result Details
Members
- applicationArn
-
- Type: string
The Amazon resource name (ARN) that specifies the application.
- attributeGroupArn
-
- Type: string
The Amazon resource name (ARN) that specifies the attribute group.
Errors
-
The specified resource does not exist.
-
The request has invalid or missing parameters.
-
The service is experiencing internal problems.
DisassociateResource
$result = $client->disassociateResource([/* ... */]); $promise = $client->disassociateResourceAsync([/* ... */]);
Disassociates a resource from application. Both the resource and the application can be specified either by ID or name.
Minimum permissions
You must have the following permissions to remove a resource that's been associated with an application using the APPLY_APPLICATION_TAG option for AssociateResource.
-
tag:GetResources -
tag:UntagResources
You must also have the following permissions if you don't use the AWSServiceCatalogAppRegistryFullAccess policy. For more information, see AWSServiceCatalogAppRegistryFullAccess in the AppRegistry Administrator Guide.
-
resource-groups:DisassociateResource -
cloudformation:UpdateStack -
cloudformation:DescribeStacks
In addition, you must have the tagging permission defined by the Amazon Web Services service that creates the resource. For more information, see UntagResources in the Resource Groups Tagging API Reference.
Parameter Syntax
$result = $client->disassociateResource([
'application' => '<string>', // REQUIRED
'resource' => '<string>', // REQUIRED
'resourceType' => 'CFN_STACK|RESOURCE_TAG_VALUE', // REQUIRED
]);
Parameter Details
Members
- application
-
- Required: Yes
- Type: string
The name or ID of the application.
- resource
-
- Required: Yes
- Type: string
The name or ID of the resource.
- resourceType
-
- Required: Yes
- Type: string
The type of the resource that is being disassociated.
Result Syntax
[
'applicationArn' => '<string>',
'resourceArn' => '<string>',
]
Result Details
Members
- applicationArn
-
- Type: string
The Amazon resource name (ARN) that specifies the application.
- resourceArn
-
- Type: string
The Amazon resource name (ARN) that specifies the resource.
Errors
-
The specified resource does not exist.
-
The service is experiencing internal problems.
-
The request has invalid or missing parameters.
-
The maximum number of API requests has been exceeded.
GetApplication
$result = $client->getApplication([/* ... */]); $promise = $client->getApplicationAsync([/* ... */]);
Retrieves metadata information about one of your applications. The application can be specified by its ARN, ID, or name (which is unique within one account in one region at a given point in time). Specify by ARN or 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.
Parameter Syntax
$result = $client->getApplication([
'application' => '<string>', // REQUIRED
]);
Parameter Details
Members
- application
-
- Required: Yes
- Type: string
The name, ID, or ARN of the application.
Result Syntax
[
'applicationTag' => ['<string>', ...],
'arn' => '<string>',
'associatedResourceCount' => <integer>,
'creationTime' => <DateTime>,
'description' => '<string>',
'id' => '<string>',
'integrations' => [
'applicationTagResourceGroup' => [
'arn' => '<string>',
'errorMessage' => '<string>',
'state' => 'CREATING|CREATE_COMPLETE|CREATE_FAILED|UPDATING|UPDATE_COMPLETE|UPDATE_FAILED',
],
'resourceGroup' => [
'arn' => '<string>',
'errorMessage' => '<string>',
'state' => 'CREATING|CREATE_COMPLETE|CREATE_FAILED|UPDATING|UPDATE_COMPLETE|UPDATE_FAILED',
],
],
'lastUpdateTime' => <DateTime>,
'name' => '<string>',
'tags' => ['<string>', ...],
]
Result Details
Members
- applicationTag
-
- Type: Associative array of custom strings keys (TagKey) to strings
A key-value pair that identifies an associated resource.
- arn
-
- Type: string
The Amazon resource name (ARN) that specifies the application across services.
- associatedResourceCount
-
- Type: int
The number of top-level resources that were registered as part of this application.
- creationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The ISO-8601 formatted timestamp of the moment when the application was created.
- description
-
- Type: string
The description of the application.
- id
-
- Type: string
The identifier of the application.
- integrations
-
- Type: Integrations structure
The information about the integration of the application with other services, such as Resource Groups.
- lastUpdateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The ISO-8601 formatted timestamp of the moment when the application was last updated.
- name
-
- Type: string
The name of the application. The name must be unique in the region in which you are creating the application.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Key-value pairs associated with the application.
Errors
-
The specified resource does not exist.
-
The request has invalid or missing parameters.
-
The service is experiencing internal problems.
-
There was a conflict when processing the request (for example, a resource with the given name already exists within the account).
GetAssociatedResource
$result = $client->getAssociatedResource([/* ... */]); $promise = $client->getAssociatedResourceAsync([/* ... */]);
Gets the resource associated with the application.
Parameter Syntax
$result = $client->getAssociatedResource([
'application' => '<string>', // REQUIRED
'maxResults' => <integer>,
'nextToken' => '<string>',
'resource' => '<string>', // REQUIRED
'resourceTagStatus' => ['<string>', ...],
'resourceType' => 'CFN_STACK|RESOURCE_TAG_VALUE', // REQUIRED
]);
Parameter Details
Members
- application
-
- Required: Yes
- Type: string
The name, ID, or ARN of the application.
- maxResults
-
- Type: int
The maximum number of results to return. If the parameter is omitted, it defaults to 25. The value is optional.
- nextToken
-
- Type: string
A unique pagination token for each page of results. Make the call again with the returned token to retrieve the next page of results.
- resource
-
- Required: Yes
- Type: string
The name or ID of the resource associated with the application.
- resourceTagStatus
-
- Type: Array of strings
States whether an application tag is applied, not applied, in the process of being applied, or skipped.
- resourceType
-
- Required: Yes
- Type: string
The type of resource associated with the application.
Result Syntax
[
'applicationTagResult' => [
'applicationTagStatus' => 'IN_PROGRESS|SUCCESS|FAILURE',
'errorMessage' => '<string>',
'nextToken' => '<string>',
'resources' => [
[
'errorMessage' => '<string>',
'resourceArn' => '<string>',
'resourceType' => '<string>',
'status' => '<string>',
],
// ...
],
],
'options' => ['<string>', ...],
'resource' => [
'arn' => '<string>',
'associationTime' => <DateTime>,
'integrations' => [
'resourceGroup' => [
'arn' => '<string>',
'errorMessage' => '<string>',
'state' => 'CREATING|CREATE_COMPLETE|CREATE_FAILED|UPDATING|UPDATE_COMPLETE|UPDATE_FAILED',
],
],
'name' => '<string>',
],
]
Result Details
Members
- applicationTagResult
-
- Type: ApplicationTagResult structure
The result of the application that's tag applied to a resource.
- options
-
- Type: Array of strings
Determines whether an application tag is applied or skipped.
- resource
-
- Type: Resource structure
The resource associated with the application.
Errors
-
The specified resource does not exist.
-
The request has invalid or missing parameters.
-
The service is experiencing internal problems.
GetAttributeGroup
$result = $client->getAttributeGroup([/* ... */]); $promise = $client->getAttributeGroupAsync([/* ... */]);
Retrieves an attribute group by its ARN, ID, or name. The attribute group can be specified by its ARN, ID, or name.
Parameter Syntax
$result = $client->getAttributeGroup([
'attributeGroup' => '<string>', // REQUIRED
]);
Parameter Details
Members
- attributeGroup
-
- Required: Yes
- Type: string
The name, ID, or ARN of the attribute group that holds the attributes to describe the application.
Result Syntax
[
'arn' => '<string>',
'attributes' => '<string>',
'createdBy' => '<string>',
'creationTime' => <DateTime>,
'description' => '<string>',
'id' => '<string>',
'lastUpdateTime' => <DateTime>,
'name' => '<string>',
'tags' => ['<string>', ...],
]
Result Details
Members
- arn
-
- Type: string
The Amazon resource name (ARN) that specifies the attribute group across services.
- attributes
-
- Type: string
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.
- createdBy
-
- Type: string
The service principal that created the attribute group.
- creationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The ISO-8601 formatted timestamp of the moment the attribute group was created.
- description
-
- Type: string
The description of the attribute group that the user provides.
- id
-
- Type: string
The identifier of the attribute group.
- lastUpdateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The ISO-8601 formatted timestamp of the moment the attribute group was last updated. This time is the same as the creationTime for a newly created attribute group.
- name
-
- Type: string
The name of the attribute group.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Key-value pairs associated with the attribute group.
Errors
-
The specified resource does not exist.
-
The request has invalid or missing parameters.
-
The service is experiencing internal problems.
-
There was a conflict when processing the request (for example, a resource with the given name already exists within the account).
GetConfiguration
$result = $client->getConfiguration([/* ... */]); $promise = $client->getConfigurationAsync([/* ... */]);
Retrieves a TagKey configuration from an account.
Parameter Syntax
$result = $client->getConfiguration([ ]);
Parameter Details
Members
Result Syntax
[
'configuration' => [
'tagQueryConfiguration' => [
'tagKey' => '<string>',
],
],
]
Result Details
Members
- configuration
-
- Type: AppRegistryConfiguration structure
Retrieves
TagKeyconfiguration from an account.
Errors
-
The service is experiencing internal problems.
ListApplications
$result = $client->listApplications([/* ... */]); $promise = $client->listApplicationsAsync([/* ... */]);
Retrieves a list of all of your applications. Results are paginated.
Parameter Syntax
$result = $client->listApplications([
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
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
-
- Type: string
The token to use to get the next page of results after a previous API call.
Result Syntax
[
'applications' => [
[
'arn' => '<string>',
'creationTime' => <DateTime>,
'description' => '<string>',
'id' => '<string>',
'lastUpdateTime' => <DateTime>,
'name' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- applications
-
- Type: Array of ApplicationSummary structures
This list of applications.
- nextToken
-
- Type: string
The token to use to get the next page of results after a previous API call.
Errors
-
The request has invalid or missing parameters.
-
The service is experiencing internal problems.
ListAssociatedAttributeGroups
$result = $client->listAssociatedAttributeGroups([/* ... */]); $promise = $client->listAssociatedAttributeGroupsAsync([/* ... */]);
Lists all attribute groups that are associated with specified application. Results are paginated.
Parameter Syntax
$result = $client->listAssociatedAttributeGroups([
'application' => '<string>', // REQUIRED
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- application
-
- Required: Yes
- Type: string
The name or ID of the application.
- maxResults
-
- Type: int
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
-
- Type: string
The token to use to get the next page of results after a previous API call.
Result Syntax
[
'attributeGroups' => ['<string>', ...],
'nextToken' => '<string>',
]
Result Details
Members
- attributeGroups
-
- Type: Array of strings
A list of attribute group IDs.
- nextToken
-
- Type: string
The token to use to get the next page of results after a previous API call.
Errors
-
The specified resource does not exist.
-
The request has invalid or missing parameters.
-
The service is experiencing internal problems.
ListAssociatedResources
$result = $client->listAssociatedResources([/* ... */]); $promise = $client->listAssociatedResourcesAsync([/* ... */]);
Lists all of the resources that are associated with the specified application. Results are paginated.
If you share an application, and a consumer account associates a tag query to the application, all of the users who can access the application can also view the tag values in all accounts that are associated with it using this API.
Parameter Syntax
$result = $client->listAssociatedResources([
'application' => '<string>', // REQUIRED
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- application
-
- Required: Yes
- Type: string
The name, ID, or ARN of the application.
- maxResults
-
- Type: int
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
-
- Type: string
The token to use to get the next page of results after a previous API call.
Result Syntax
[
'nextToken' => '<string>',
'resources' => [
[
'arn' => '<string>',
'name' => '<string>',
'options' => ['<string>', ...],
'resourceDetails' => [
'tagValue' => '<string>',
],
'resourceType' => 'CFN_STACK|RESOURCE_TAG_VALUE',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
The token to use to get the next page of results after a previous API call.
- resources
-
- Type: Array of ResourceInfo structures
Information about the resources.
Errors
-
The specified resource does not exist.
-
The request has invalid or missing parameters.
-
The service is experiencing internal problems.
ListAttributeGroups
$result = $client->listAttributeGroups([/* ... */]); $promise = $client->listAttributeGroupsAsync([/* ... */]);
Lists all attribute groups which you have access to. Results are paginated.
Parameter Syntax
$result = $client->listAttributeGroups([
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
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
-
- Type: string
The token to use to get the next page of results after a previous API call.
Result Syntax
[
'attributeGroups' => [
[
'arn' => '<string>',
'createdBy' => '<string>',
'creationTime' => <DateTime>,
'description' => '<string>',
'id' => '<string>',
'lastUpdateTime' => <DateTime>,
'name' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- attributeGroups
-
- Type: Array of AttributeGroupSummary structures
This list of attribute groups.
- nextToken
-
- Type: string
The token to use to get the next page of results after a previous API call.
Errors
-
The request has invalid or missing parameters.
-
The service is experiencing internal problems.
ListAttributeGroupsForApplication
$result = $client->listAttributeGroupsForApplication([/* ... */]); $promise = $client->listAttributeGroupsForApplicationAsync([/* ... */]);
Lists the details of all attribute groups associated with a specific application. The results display in pages.
Parameter Syntax
$result = $client->listAttributeGroupsForApplication([
'application' => '<string>', // REQUIRED
'maxResults' => <integer>,
'nextToken' => '<string>',
]);
Parameter Details
Members
- application
-
- Required: Yes
- Type: string
The name or ID of the application.
- maxResults
-
- Type: int
The upper bound of the number of results to return. The value cannot exceed 25. If you omit this parameter, it defaults to 25. This value is optional.
- nextToken
-
- Type: string
This token retrieves the next page of results after a previous API call.
Result Syntax
[
'attributeGroupsDetails' => [
[
'arn' => '<string>',
'createdBy' => '<string>',
'id' => '<string>',
'name' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- attributeGroupsDetails
-
- Type: Array of AttributeGroupDetails structures
The details related to a specific attribute group.
- nextToken
-
- Type: string
The token to use to get the next page of results after a previous API call.
Errors
-
The specified resource does not exist.
-
The request has invalid or missing parameters.
-
The service is experiencing internal problems.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Lists all of the tags on the resource.
Parameter Syntax
$result = $client->listTagsForResource([
'resourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon resource name (ARN) that specifies the resource.
Result Syntax
[
'tags' => ['<string>', ...],
]
Result Details
Members
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags on the resource.
Errors
-
The request has invalid or missing parameters.
-
The specified resource does not exist.
-
The service is experiencing internal problems.
PutConfiguration
$result = $client->putConfiguration([/* ... */]); $promise = $client->putConfigurationAsync([/* ... */]);
Associates a TagKey configuration to an account.
Parameter Syntax
$result = $client->putConfiguration([
'configuration' => [ // REQUIRED
'tagQueryConfiguration' => [
'tagKey' => '<string>',
],
],
]);
Parameter Details
Members
- configuration
-
- Required: Yes
- Type: AppRegistryConfiguration structure
Associates a
TagKeyconfiguration to an account.
Result Syntax
[]
Result Details
Errors
-
There was a conflict when processing the request (for example, a resource with the given name already exists within the account).
-
The service is experiencing internal problems.
-
The request has invalid or missing parameters.
SyncResource
$result = $client->syncResource([/* ... */]); $promise = $client->syncResourceAsync([/* ... */]);
Syncs the resource with current AppRegistry records.
Specifically, the resource’s AppRegistry system tags sync with its associated application. We remove the resource's AppRegistry system tags if it does not associate with the application. The caller must have permissions to read and update the resource.
Parameter Syntax
$result = $client->syncResource([
'resource' => '<string>', // REQUIRED
'resourceType' => 'CFN_STACK|RESOURCE_TAG_VALUE', // REQUIRED
]);
Parameter Details
Members
- resource
-
- Required: Yes
- Type: string
An entity you can work with and specify with a name or ID. Examples include an Amazon EC2 instance, an Amazon Web Services CloudFormation stack, or an Amazon S3 bucket.
- resourceType
-
- Required: Yes
- Type: string
The type of resource of which the application will be associated.
Result Syntax
[
'actionTaken' => 'START_SYNC|NO_ACTION',
'applicationArn' => '<string>',
'resourceArn' => '<string>',
]
Result Details
Members
- actionTaken
-
- Type: string
The results of the output if an application is associated with an ARN value, which could be
syncStartedor None. - applicationArn
-
- Type: string
The Amazon resource name (ARN) that specifies the application.
- resourceArn
-
- Type: string
The Amazon resource name (ARN) that specifies the resource.
Errors
-
The specified resource does not exist.
-
The service is experiencing internal problems.
-
There was a conflict when processing the request (for example, a resource with the given name already exists within the account).
-
The maximum number of API requests has been exceeded.
-
The request has invalid or missing parameters.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->tagResource([
'resourceArn' => '<string>', // REQUIRED
'tags' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon resource name (ARN) that specifies the resource.
- tags
-
- Required: Yes
- Type: Associative array of custom strings keys (TagKey) to strings
The new or modified tags for the resource.
Result Syntax
[]
Result Details
Errors
-
The request has invalid or missing parameters.
-
The specified resource does not exist.
-
The service is experiencing internal problems.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Removes tags from a resource.
This operation returns an empty response if the call was successful.
Parameter Syntax
$result = $client->untagResource([
'resourceArn' => '<string>', // REQUIRED
'tagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The Amazon resource name (ARN) that specifies the resource.
- tagKeys
-
- Required: Yes
- Type: Array of strings
A list of the tag keys to remove from the specified resource.
Result Syntax
[]
Result Details
Errors
-
The request has invalid or missing parameters.
-
The specified resource does not exist.
-
The service is experiencing internal problems.
UpdateApplication
$result = $client->updateApplication([/* ... */]); $promise = $client->updateApplicationAsync([/* ... */]);
Updates an existing application with new attributes.
Parameter Syntax
$result = $client->updateApplication([
'application' => '<string>', // REQUIRED
'description' => '<string>',
'name' => '<string>',
]);
Parameter Details
Members
- application
-
- Required: Yes
- Type: string
The name, ID, or ARN of the application that will be updated.
- description
-
- Type: string
The new description of the application.
- name
-
- Type: string
Deprecated: The new name of the application. The name must be unique in the region in which you are updating the application. Please do not use this field as we have stopped supporting name updates.
Result Syntax
[
'application' => [
'applicationTag' => ['<string>', ...],
'arn' => '<string>',
'creationTime' => <DateTime>,
'description' => '<string>',
'id' => '<string>',
'lastUpdateTime' => <DateTime>,
'name' => '<string>',
'tags' => ['<string>', ...],
],
]
Result Details
Members
- application
-
- Type: Application structure
The updated information of the application.
Errors
-
The specified resource does not exist.
-
There was a conflict when processing the request (for example, a resource with the given name already exists within the account).
-
The request has invalid or missing parameters.
-
The service is experiencing internal problems.
-
The maximum number of API requests has been exceeded.
UpdateAttributeGroup
$result = $client->updateAttributeGroup([/* ... */]); $promise = $client->updateAttributeGroupAsync([/* ... */]);
Updates an existing attribute group with new details.
Parameter Syntax
$result = $client->updateAttributeGroup([
'attributeGroup' => '<string>', // REQUIRED
'attributes' => '<string>',
'description' => '<string>',
'name' => '<string>',
]);
Parameter Details
Members
- attributeGroup
-
- Required: Yes
- Type: string
The name, ID, or ARN of the attribute group that holds the attributes to describe the application.
- attributes
-
- Type: string
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
-
- Type: string
The description of the attribute group that the user provides.
- name
-
- Type: string
Deprecated: The new name of the attribute group. The name must be unique in the region in which you are updating the attribute group. Please do not use this field as we have stopped supporting name updates.
Result Syntax
[
'attributeGroup' => [
'arn' => '<string>',
'creationTime' => <DateTime>,
'description' => '<string>',
'id' => '<string>',
'lastUpdateTime' => <DateTime>,
'name' => '<string>',
'tags' => ['<string>', ...],
],
]
Result Details
Members
- attributeGroup
-
- Type: AttributeGroup structure
The updated information of the attribute group.
Errors
-
The specified resource does not exist.
-
The request has invalid or missing parameters.
-
There was a conflict when processing the request (for example, a resource with the given name already exists within the account).
-
The service is experiencing internal problems.
Shapes
AppRegistryConfiguration
Description
Includes all of the AppRegistry settings.
Members
- tagQueryConfiguration
-
- Type: TagQueryConfiguration structure
Includes the definition of a
tagQuery.
Application
Description
Represents a Amazon Web Services Service Catalog AppRegistry application that is the top-level node in a hierarchy of related cloud resource abstractions.
Members
- applicationTag
-
- Type: Associative array of custom strings keys (TagKey) to strings
A key-value pair that identifies an associated resource.
- arn
-
- Type: string
The Amazon resource name (ARN) that specifies the application across services.
- creationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The ISO-8601 formatted timestamp of the moment when the application was created.
- description
-
- Type: string
The description of the application.
- id
-
- Type: string
The identifier of the application.
- lastUpdateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The ISO-8601 formatted timestamp of the moment when the application was last updated.
- name
-
- Type: string
The name of the application. The name must be unique in the region in which you are creating the application.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Key-value pairs you can use to associate with the application.
ApplicationSummary
Description
Summary of a Amazon Web Services Service Catalog AppRegistry application.
Members
- arn
-
- Type: string
The Amazon resource name (ARN) that specifies the application across services.
- creationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The ISO-8601 formatted timestamp of the moment when the application was created.
- description
-
- Type: string
The description of the application.
- id
-
- Type: string
The identifier of the application.
- lastUpdateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The ISO-8601 formatted timestamp of the moment when the application was last updated.
- name
-
- Type: string
The name of the application. The name must be unique in the region in which you are creating the application.
ApplicationTagResult
Description
The result of the application tag that's applied to a resource.
Members
- applicationTagStatus
-
- Type: string
The application tag is in the process of being applied to a resource, was successfully applied to a resource, or failed to apply to a resource.
- errorMessage
-
- Type: string
The message returned if the call fails.
- nextToken
-
- Type: string
A unique pagination token for each page of results. Make the call again with the returned token to retrieve the next page of results.
- resources
-
- Type: Array of ResourcesListItem structures
The resources associated with an application
AttributeGroup
Description
Represents a Amazon Web Services Service Catalog AppRegistry attribute group that is rich metadata which describes an application and its components.
Members
- arn
-
- Type: string
The Amazon resource name (ARN) that specifies the attribute group across services.
- creationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The ISO-8601 formatted timestamp of the moment the attribute group was created.
- description
-
- Type: string
The description of the attribute group that the user provides.
- id
-
- Type: string
The globally unique attribute group identifier of the attribute group.
- lastUpdateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The ISO-8601 formatted timestamp of the moment the attribute group was last updated. This time is the same as the creationTime for a newly created attribute group.
- name
-
- Type: string
The name of the attribute group.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
Key-value pairs you can use to associate with the attribute group.
AttributeGroupDetails
Description
The details related to a specific AttributeGroup.
Members
- arn
-
- Type: string
The Amazon resource name (ARN) that specifies the attribute group.
- createdBy
-
- Type: string
The service principal that created the attribute group.
- id
-
- Type: string
The unique identifier of the attribute group.
- name
-
- Type: string
This field is no longer supported. We recommend you don't use the field when using
ListAttributeGroupsForApplication.The name of the attribute group.
AttributeGroupSummary
Description
Summary of a Amazon Web Services Service Catalog AppRegistry attribute group.
Members
- arn
-
- Type: string
The Amazon resource name (ARN) that specifies the attribute group across services.
- createdBy
-
- Type: string
The service principal that created the attribute group.
- creationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The ISO-8601 formatted timestamp of the moment the attribute group was created.
- description
-
- Type: string
The description of the attribute group that the user provides.
- id
-
- Type: string
The globally unique attribute group identifier of the attribute group.
- lastUpdateTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The ISO-8601 formatted timestamp of the moment the attribute group was last updated. This time is the same as the creationTime for a newly created attribute group.
- name
-
- Type: string
The name of the attribute group.
ConflictException
Description
There was a conflict when processing the request (for example, a resource with the given name already exists within the account).
Members
- message
-
- Type: string
Integrations
Description
The information about the service integration.
Members
- applicationTagResourceGroup
-
- Type: ResourceGroup structure
The information about the resource group integration.
- resourceGroup
-
- Type: ResourceGroup structure
The information about the resource group integration.
InternalServerException
Description
The service is experiencing internal problems.
Members
- message
-
- Type: string
Resource
Description
The information about the resource.
Members
- arn
-
- Type: string
The Amazon resource name (ARN) of the resource.
- associationTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time the resource was associated with the application.
- integrations
-
- Type: ResourceIntegrations structure
The service integration information about the resource.
- name
-
- Type: string
The name of the resource.
ResourceDetails
Description
The details related to the resource.
Members
- tagValue
-
- Type: string
The value of the tag.
ResourceGroup
Description
The information about the resource group integration.
Members
- arn
-
- Type: string
The Amazon resource name (ARN) of the resource group.
- errorMessage
-
- Type: string
The error message that generates when the propagation process for the resource group fails.
- state
-
- Type: string
The state of the propagation process for the resource group. The states includes:
CREATINGif the resource group is in the process of being created.CREATE_COMPLETEif the resource group was created successfully.CREATE_FAILEDif the resource group failed to be created.UPDATINGif the resource group is in the process of being updated.UPDATE_COMPLETEif the resource group updated successfully.UPDATE_FAILEDif the resource group could not update successfully.
ResourceInfo
Description
The information about the resource.
Members
- arn
-
- Type: string
The Amazon resource name (ARN) that specifies the resource across services.
- name
-
- Type: string
The name of the resource.
- options
-
- Type: Array of strings
Determines whether an application tag is applied or skipped.
- resourceDetails
-
- Type: ResourceDetails structure
The details related to the resource.
- resourceType
-
- Type: string
Provides information about the Service Catalog App Registry resource type.
ResourceIntegrations
Description
The service integration information about the resource.
Members
- resourceGroup
-
- Type: ResourceGroup structure
The information about the integration of Resource Groups.
ResourceNotFoundException
Description
The specified resource does not exist.
Members
- message
-
- Type: string
ResourcesListItem
Description
The resource in a list of resources.
Members
- errorMessage
-
- Type: string
The message returned if the call fails.
- resourceArn
-
- Type: string
The Amazon resource name (ARN) of the resource.
- resourceType
-
- Type: string
Provides information about the AppRegistry resource type.
- status
-
- Type: string
The status of the list item.
ServiceQuotaExceededException
Description
The maximum number of resources per account has been reached.
Members
- message
-
- Type: string
TagQueryConfiguration
Description
The definition of tagQuery. Specifies which resources are associated with an application.
Members
- tagKey
-
- Type: string
Condition in the IAM policy that associates resources to an application.
ThrottlingException
Description
The maximum number of API requests has been exceeded.
Members
- message
-
- Required: Yes
- Type: string
A message associated with the Throttling exception.
- serviceCode
-
- Type: string
The originating service code.
ValidationException
Description
The request has invalid or missing parameters.
Members
- message
-
- Type: string