# GetMarketplaceResource
<a name="API_GetMarketplaceResource"></a>

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.

## Request Syntax
<a name="API_GetMarketplaceResource_RequestSyntax"></a>

```
POST /GetMarketplaceResource HTTP/1.1
Content-type: application/json

{
   "resourceArn": "string",
   "resourceLocation": "string",
   "resourceType": "string"
}
```

## URI Request Parameters
<a name="API_GetMarketplaceResource_RequestParameters"></a>

The request does not use any URI parameters.

## Request Body
<a name="API_GetMarketplaceResource_RequestBody"></a>

The request accepts the following data in JSON format.

 ** [resourceArn](#API_GetMarketplaceResource_RequestSyntax) **   <a name="imagebuilder-GetMarketplaceResource-request-resourceArn"></a>
The Amazon Resource Name (ARN) that uniquely identifies an Amazon Web Services Marketplace resource.  
Type: String  
Pattern: `^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\.(?:x|[0-9]+)\.(?:x|[0-9]+))(?:/[0-9]+)?)?$`   
Required: Yes

 ** [resourceLocation](#API_GetMarketplaceResource_RequestSyntax) **   <a name="imagebuilder-GetMarketplaceResource-request-resourceLocation"></a>
The bucket path that you can specify to download the resource from Amazon S3.  
Type: String  
Length Constraints: Maximum length of 1024.  
Pattern: `^s3://[^/]+/.+[^/]$`   
Required: No

 ** [resourceType](#API_GetMarketplaceResource_RequestSyntax) **   <a name="imagebuilder-GetMarketplaceResource-request-resourceType"></a>
Specifies which type of Amazon Web Services Marketplace resource Image Builder retrieves.  
Type: String  
Valid Values: `COMPONENT_DATA | COMPONENT_ARTIFACT`   
Required: Yes

## Response Syntax
<a name="API_GetMarketplaceResource_ResponseSyntax"></a>

```
HTTP/1.1 200
Content-type: application/json

{
   "data": "string",
   "resourceArn": "string",
   "url": "string"
}
```

## Response Elements
<a name="API_GetMarketplaceResource_ResponseElements"></a>

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

 ** [data](#API_GetMarketplaceResource_ResponseSyntax) **   <a name="imagebuilder-GetMarketplaceResource-response-data"></a>
Returns obfuscated data that contains the YAML content of the component.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

 ** [resourceArn](#API_GetMarketplaceResource_ResponseSyntax) **   <a name="imagebuilder-GetMarketplaceResource-response-resourceArn"></a>
The Amazon Resource Name (ARN) for the Amazon Web Services Marketplace resource that was requested.  
Type: String  
Pattern: `^arn:aws[^:]*:imagebuilder:[^:]+:(?:[0-9]{12}|aws(?:-[a-z-]+)?):(?:image-recipe|container-recipe|infrastructure-configuration|distribution-configuration|component|image|image-pipeline|lifecycle-policy|workflow\/(?:build|test|distribution))/[a-z0-9-_]+(?:/(?:(?:x|[0-9]+)\.(?:x|[0-9]+)\.(?:x|[0-9]+))(?:/[0-9]+)?)?$` 

 ** [url](#API_GetMarketplaceResource_ResponseSyntax) **   <a name="imagebuilder-GetMarketplaceResource-response-url"></a>
The obfuscated S3 URL to download the component artifact from.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.

## Errors
<a name="API_GetMarketplaceResource_Errors"></a>

For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md).

 ** CallRateLimitExceededException **   
You have exceeded the permitted request rate for the specific operation.  
HTTP Status Code: 429

 ** ClientException **   
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.  
HTTP Status Code: 400

 ** ForbiddenException **   
You are not authorized to perform the requested operation.  
HTTP Status Code: 403

 ** InvalidRequestException **   
You have requested an action that that the service doesn't support.  
HTTP Status Code: 400

 ** ServiceException **   
This exception is thrown when the service encounters an unrecoverable exception.  
HTTP Status Code: 500

 ** ServiceUnavailableException **   
The service is unable to process your request at this time.  
HTTP Status Code: 503

## See Also
<a name="API_GetMarketplaceResource_SeeAlso"></a>

For more information about using this API in one of the language-specific Amazon SDKs, see the following:
+  [Amazon Command Line Interface V2](https://docs.amazonaws.cn/goto/cli2/imagebuilder-2019-12-02/GetMarketplaceResource) 
+  [Amazon SDK for .NET V4](https://docs.amazonaws.cn/goto/DotNetSDKV4/imagebuilder-2019-12-02/GetMarketplaceResource) 
+  [Amazon SDK for C\$1\$1](https://docs.amazonaws.cn/goto/SdkForCpp/imagebuilder-2019-12-02/GetMarketplaceResource) 
+  [Amazon SDK for Go v2](https://docs.amazonaws.cn/goto/SdkForGoV2/imagebuilder-2019-12-02/GetMarketplaceResource) 
+  [Amazon SDK for Java V2](https://docs.amazonaws.cn/goto/SdkForJavaV2/imagebuilder-2019-12-02/GetMarketplaceResource) 
+  [Amazon SDK for JavaScript V3](https://docs.amazonaws.cn/goto/SdkForJavaScriptV3/imagebuilder-2019-12-02/GetMarketplaceResource) 
+  [Amazon SDK for Kotlin](https://docs.amazonaws.cn/goto/SdkForKotlin/imagebuilder-2019-12-02/GetMarketplaceResource) 
+  [Amazon SDK for PHP V3](https://docs.amazonaws.cn/goto/SdkForPHPV3/imagebuilder-2019-12-02/GetMarketplaceResource) 
+  [Amazon SDK for Python](https://docs.amazonaws.cn/goto/boto3/imagebuilder-2019-12-02/GetMarketplaceResource) 
+  [Amazon SDK for Ruby V3](https://docs.amazonaws.cn/goto/SdkForRubyV3/imagebuilder-2019-12-02/GetMarketplaceResource)