imagebuilder / Client / get_marketplace_resource

get_marketplace_resource#

imagebuilder.Client.get_marketplace_resource(**kwargs)#

Verify the subscription and perform resource dependency checks on the requested Amazon Web Services Marketplace resource. For Amazon Web Services Marketplace components, the response contains fields to download the components and their artifacts.

See also: AWS API Documentation

Request Syntax

response = client.get_marketplace_resource(
    resourceType='COMPONENT_DATA'|'COMPONENT_ARTIFACT',
    resourceArn='string',
    resourceLocation='string'
)
Parameters:

  • resourceType (string) –

    [REQUIRED]

    Specifies which type of Amazon Web Services Marketplace resource Image Builder retrieves.

  • resourceArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) that uniquely identifies an Amazon Web Services Marketplace resource.

  • resourceLocation (string) – The bucket path that you can specify to download the resource from Amazon S3.

Return type:

dict

Returns:

Response Syntax

{
    'resourceArn': 'string',
    'url': 'string',
    'data': 'string'
}

Response Structure

  • (dict) –

    • resourceArn (string) –

      The Amazon Resource Name (ARN) for the Amazon Web Services Marketplace resource that was requested.

    • url (string) –

      The obfuscated S3 URL to download the component artifact from.

    • data (string) –

      Returns obfuscated data that contains the YAML content of the component.

Exceptions

  • imagebuilder.Client.exceptions.ServiceException

  • imagebuilder.Client.exceptions.ClientException

  • imagebuilder.Client.exceptions.ServiceUnavailableException

  • imagebuilder.Client.exceptions.InvalidRequestException

  • imagebuilder.Client.exceptions.ForbiddenException

  • imagebuilder.Client.exceptions.CallRateLimitExceededException