AppRegistry / Client / sync_resource

sync_resource#

AppRegistry.Client.sync_resource(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.sync_resource(
    resourceType='CFN_STACK'|'RESOURCE_TAG_VALUE',
    resource='string'
)
Parameters:

  • resourceType (string) –

    [REQUIRED]

    The type of resource of which the application will be associated.

  • resource (string) –

    [REQUIRED]

    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.

Return type:

dict

Returns:

Response Syntax

{
    'applicationArn': 'string',
    'resourceArn': 'string',
    'actionTaken': 'START_SYNC'|'NO_ACTION'
}

Response Structure

  • (dict) –

    • applicationArn (string) –

      The Amazon resource name (ARN) that specifies the application.

    • resourceArn (string) –

      The Amazon resource name (ARN) that specifies the resource.

    • actionTaken (string) –

      The results of the output if an application is associated with an ARN value, which could be syncStarted or None.

Exceptions

  • AppRegistry.Client.exceptions.ResourceNotFoundException

  • AppRegistry.Client.exceptions.InternalServerException

  • AppRegistry.Client.exceptions.ConflictException

  • AppRegistry.Client.exceptions.ThrottlingException

  • AppRegistry.Client.exceptions.ValidationException