CloudControlApi / Client / get_resource

get_resource#

CloudControlApi.Client.get_resource(**kwargs)#

Returns information about the current state of the specified resource. For details, see Reading a resource’s current state.

You can use this action to return information about an existing resource in your account and Amazon Web Services Region, whether those resources were provisioned using Cloud Control API.

See also: AWS API Documentation

Request Syntax

response = client.get_resource(
    TypeName='string',
    TypeVersionId='string',
    RoleArn='string',
    Identifier='string'
)
Parameters:

  • TypeName (string) –

    [REQUIRED]

    The name of the resource type.

  • TypeVersionId (string) – For private resource types, the type version to use in this resource operation. If you do not specify a resource version, CloudFormation uses the default version.

  • RoleArn (string) –

    The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role for Cloud Control API to use when performing this resource operation. The role specified must have the permissions required for this operation. The necessary permissions for each event handler are defined in the ``handlers ``section of the resource type definition schema.

    If you do not specify a role, Cloud Control API uses a temporary session created using your Amazon Web Services user credentials.

    For more information, see Specifying credentials in the Amazon Web Services Cloud Control API User Guide.

  • Identifier (string) –

    [REQUIRED]

    The identifier for the resource.

    You can specify the primary identifier, or any secondary identifier defined for the resource type in its resource schema. You can only specify one identifier. Primary identifiers can be specified as a string or JSON; secondary identifiers must be specified as JSON.

    For compound primary identifiers (that is, one that consists of multiple resource properties strung together), to specify the primary identifier as a string, list the property values in the order they are specified in the primary identifier definition, separated by |.

    For more information, see Identifying resources in the Amazon Web Services Cloud Control API User Guide.

Return type:

dict

Returns:

Response Syntax

{
    'TypeName': 'string',
    'ResourceDescription': {
        'Identifier': 'string',
        'Properties': 'string'
    }
}

Response Structure

  • (dict) –

    • TypeName (string) –

      The name of the resource type.

    • ResourceDescription (dict) –

      Represents information about a provisioned resource.

      • Identifier (string) –

        The primary identifier for the resource.

        For more information, see Identifying resources in the Amazon Web Services Cloud Control API User Guide.

      • Properties (string) –

        A list of the resource properties and their current values.

Exceptions

  • CloudControlApi.Client.exceptions.AlreadyExistsException

  • CloudControlApi.Client.exceptions.HandlerInternalFailureException

  • CloudControlApi.Client.exceptions.GeneralServiceException

  • CloudControlApi.Client.exceptions.NotUpdatableException

  • CloudControlApi.Client.exceptions.TypeNotFoundException

  • CloudControlApi.Client.exceptions.InvalidRequestException

  • CloudControlApi.Client.exceptions.PrivateTypeException

  • CloudControlApi.Client.exceptions.ResourceNotFoundException

  • CloudControlApi.Client.exceptions.NetworkFailureException

  • CloudControlApi.Client.exceptions.UnsupportedActionException

  • CloudControlApi.Client.exceptions.NotStabilizedException

  • CloudControlApi.Client.exceptions.ServiceInternalErrorException

  • CloudControlApi.Client.exceptions.HandlerFailureException

  • CloudControlApi.Client.exceptions.ServiceLimitExceededException

  • CloudControlApi.Client.exceptions.InvalidCredentialsException

  • CloudControlApi.Client.exceptions.ResourceConflictException

  • CloudControlApi.Client.exceptions.ThrottlingException