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

Result Syntax

[
    'applicationArn' => '<string>',
    'attributeGroupArn' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

ValidationException:

The request has invalid or missing parameters.

InternalServerException:

The service is experiencing internal problems.

ServiceQuotaExceededException:

The maximum number of resources per account has been reached.

ConflictException:

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:AssociateResource

• cloudformation:UpdateStack

• cloudformation:DescribeStacks

Parameter Syntax

$result = $client->associateResource([
    'application' => '<string>', // REQUIRED
    'options' => ['<string>', ...],
    'resource' => '<string>', // REQUIRED
    'resourceType' => 'CFN_STACK|RESOURCE_TAG_VALUE', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'applicationArn' => '<string>',
    'options' => ['<string>', ...],
    'resourceArn' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

InternalServerException:

The service is experiencing internal problems.

ServiceQuotaExceededException:

The maximum number of resources per account has been reached.

ConflictException:

There was a conflict when processing the request (for example, a resource with the given name already exists within the account).

ValidationException:

The request has invalid or missing parameters.

ThrottlingException:

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

Result Syntax

[
    'application' => [
        'applicationTag' => ['<string>', ...],
        'arn' => '<string>',
        'creationTime' => <DateTime>,
        'description' => '<string>',
        'id' => '<string>',
        'lastUpdateTime' => <DateTime>,
        'name' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

The maximum number of resources per account has been reached.

ConflictException:

There was a conflict when processing the request (for example, a resource with the given name already exists within the account).

InternalServerException:

The service is experiencing internal problems.

ValidationException:

The request has invalid or missing parameters.

ThrottlingException:

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

Result Syntax

[
    'attributeGroup' => [
        'arn' => '<string>',
        'creationTime' => <DateTime>,
        'description' => '<string>',
        'id' => '<string>',
        'lastUpdateTime' => <DateTime>,
        'name' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ServiceQuotaExceededException:

The maximum number of resources per account has been reached.

ConflictException:

There was a conflict when processing the request (for example, a resource with the given name already exists within the account).

ValidationException:

The request has invalid or missing parameters.

InternalServerException:

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

Result Syntax

[
    'application' => [
        'arn' => '<string>',
        'creationTime' => <DateTime>,
        'description' => '<string>',
        'id' => '<string>',
        'lastUpdateTime' => <DateTime>,
        'name' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

ValidationException:

The request has invalid or missing parameters.

InternalServerException:

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

Result Syntax

[
    'attributeGroup' => [
        'arn' => '<string>',
        'createdBy' => '<string>',
        'creationTime' => <DateTime>,
        'description' => '<string>',
        'id' => '<string>',
        'lastUpdateTime' => <DateTime>,
        'name' => '<string>',
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

ValidationException:

The request has invalid or missing parameters.

InternalServerException:

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

Result Syntax

[
    'applicationArn' => '<string>',
    'attributeGroupArn' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

ValidationException:

The request has invalid or missing parameters.

InternalServerException:

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

Parameter Syntax

$result = $client->disassociateResource([
    'application' => '<string>', // REQUIRED
    'resource' => '<string>', // REQUIRED
    'resourceType' => 'CFN_STACK|RESOURCE_TAG_VALUE', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'applicationArn' => '<string>',
    'resourceArn' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

InternalServerException:

The service is experiencing internal problems.

ValidationException:

The request has invalid or missing parameters.

ThrottlingException:

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

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

Errors

ResourceNotFoundException:

The specified resource does not exist.

ValidationException:

The request has invalid or missing parameters.

InternalServerException:

The service is experiencing internal problems.

ConflictException:

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

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

Errors

ResourceNotFoundException:

The specified resource does not exist.

ValidationException:

The request has invalid or missing parameters.

InternalServerException:

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

Result Syntax

[
    'arn' => '<string>',
    'attributes' => '<string>',
    'createdBy' => '<string>',
    'creationTime' => <DateTime>,
    'description' => '<string>',
    'id' => '<string>',
    'lastUpdateTime' => <DateTime>,
    'name' => '<string>',
    'tags' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

ValidationException:

The request has invalid or missing parameters.

InternalServerException:

The service is experiencing internal problems.

ConflictException:

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

Result Syntax

[
    'configuration' => [
        'tagQueryConfiguration' => [
            'tagKey' => '<string>',
        ],
    ],
]

Result Details

Errors

InternalServerException:

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

Result Syntax

[
    'applications' => [
        [
            'arn' => '<string>',
            'creationTime' => <DateTime>,
            'description' => '<string>',
            'id' => '<string>',
            'lastUpdateTime' => <DateTime>,
            'name' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

InternalServerException:

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

Result Syntax

[
    'attributeGroups' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

ValidationException:

The request has invalid or missing parameters.

InternalServerException:

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.

Parameter Syntax

$result = $client->listAssociatedResources([
    'application' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'resources' => [
        [
            'arn' => '<string>',
            'name' => '<string>',
            'options' => ['<string>', ...],
            'resourceDetails' => [
                'tagValue' => '<string>',
            ],
            'resourceType' => 'CFN_STACK|RESOURCE_TAG_VALUE',
        ],
        // ...
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

ValidationException:

The request has invalid or missing parameters.

InternalServerException:

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

Result Syntax

[
    'attributeGroups' => [
        [
            'arn' => '<string>',
            'createdBy' => '<string>',
            'creationTime' => <DateTime>,
            'description' => '<string>',
            'id' => '<string>',
            'lastUpdateTime' => <DateTime>,
            'name' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

InternalServerException:

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

Result Syntax

[
    'attributeGroupsDetails' => [
        [
            'arn' => '<string>',
            'createdBy' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

ValidationException:

The request has invalid or missing parameters.

InternalServerException:

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

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The specified resource does not exist.

InternalServerException:

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

Result Syntax

[]

Result Details

Errors

ConflictException:

There was a conflict when processing the request (for example, a resource with the given name already exists within the account).

InternalServerException:

The service is experiencing internal problems.

ValidationException:

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

Result Syntax

[
    'actionTaken' => 'START_SYNC|NO_ACTION',
    'applicationArn' => '<string>',
    'resourceArn' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

InternalServerException:

The service is experiencing internal problems.

ConflictException:

There was a conflict when processing the request (for example, a resource with the given name already exists within the account).

ThrottlingException:

The maximum number of API requests has been exceeded.

ValidationException:

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

Result Syntax

[]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The specified resource does not exist.

InternalServerException:

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

Result Syntax

[]

Result Details

Errors

ValidationException:

The request has invalid or missing parameters.

ResourceNotFoundException:

The specified resource does not exist.

InternalServerException:

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

Result Syntax

[
    'application' => [
        'applicationTag' => ['<string>', ...],
        'arn' => '<string>',
        'creationTime' => <DateTime>,
        'description' => '<string>',
        'id' => '<string>',
        'lastUpdateTime' => <DateTime>,
        'name' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

ConflictException:

There was a conflict when processing the request (for example, a resource with the given name already exists within the account).

ValidationException:

The request has invalid or missing parameters.

InternalServerException:

The service is experiencing internal problems.

ThrottlingException:

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

Result Syntax

[
    'attributeGroup' => [
        'arn' => '<string>',
        'creationTime' => <DateTime>,
        'description' => '<string>',
        'id' => '<string>',
        'lastUpdateTime' => <DateTime>,
        'name' => '<string>',
        'tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ResourceNotFoundException:

The specified resource does not exist.

ValidationException:

The request has invalid or missing parameters.

ConflictException:

There was a conflict when processing the request (for example, a resource with the given name already exists within the account).

InternalServerException:

The service is experiencing internal problems.