id
stringlengths 14
16
| text
stringlengths 1
2.43k
| source
stringlengths 99
229
|
|---|---|---|
74fd140dfbed-0 | **maxValue** <a name="personalize-Type-IntegerHyperParameterRange-maxValue"></a>
The maximum allowable value for the hyperparameter\.
Type: Integer
Valid Range: Maximum value of 1000000\.
Required: No
**minValue** <a name="personalize-Type-IntegerHyperParameterRange-minValue"></a>
The minimum allowable value for the hyperparameter\.
Type: Integer
Valid Range: Minimum value of \-1000000\.
Required: No
**name** <a name="personalize-Type-IntegerHyperParameterRange-name"></a>
The name of the hyperparameter\.
Type: String
Length Constraints: Maximum length of 256\.
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_IntegerHyperParameterRange.md |
0bb7f815295c-0 | For more information about using this API in one of the language\-specific AWS SDKs, see the following:
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/IntegerHyperParameterRange)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/IntegerHyperParameterRange)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/IntegerHyperParameterRange)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/IntegerHyperParameterRange) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_IntegerHyperParameterRange.md |
a89233532d19-0 | This topic explains how to get started programming Amazon Personalize with the AWS SDK for Python \(Boto3\)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/getting-started-python.md |
eb027f76e664-0 | The following are prerequisite steps for using the Python examples in this guide:
+ Complete the Getting Started [Getting Started Prerequisites](gs-prerequisites.md)\. You can use the same source data that is listed in the [Getting Started \(Console\)](getting-started-console.md) or [Getting Started \(AWS CLI\)](getting-started-cli.md) exercises\. If you are using your own source data, make sure your data is formatted like in the prerequisite step [Creating the Training Data](gs-prerequisites.md#gs-upload-to-bucket)\. For information about preparing your own source data, see [Preparing and Importing Data](data-prep.md)\.
+ Set up your AWS SDK for Python \(Boto3\) environment, as specified in [Setting Up the AWS SDKs](aws-personalize-set-up-sdks.md)\.
After you finish this exercise, to avoid incurring unnecessary charges, delete the resources you created\. For more information, see [Clean Up Resources](gs-cleanup.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/getting-started-python.md |
d2b1c2bde493-0 | After you complete the prerequisites, run the following Python example to confirm that your environment is configured correctly\. If your environment is configured correctly, a list of the available recipes is displayed and you can run the other Python examples in this guide\.
```
import boto3
personalize = boto3.client('personalize')
response = personalize.list_recipes()
for recipe in response['recipes']:
print (recipe)
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/getting-started-python.md |
d9f74387d56b-0 | After you verify that your Python environment is configured correctly, import your data\. To use a dataset for training, you need to do the following:
1. Add a schema\. The schema allows Amazon Personalize to parse the training dataset\. For a code sample, see [Datasets and Schemas](how-it-works-dataset-schema.md)\.
1. Import the data\. You create a dataset group which contains one or several datasets that Amazon Personalize can use for training\. For a code sample, see [Import Your Data Using the AWS Python SDK](data-prep-importing.md#python-import-ex)\.
1. \(Optional\) Add an event tracker\. To add an event to train a model, you must add a tracking ID to associate the event with your dataset group\. For a code sample, see [Getting a Tracking ID](recording-events.md#event-get-tracker)\.
1. \(Optional\) Add an event record\. To add more data in training and create a better model, you can use events\. Events are recorded user activities such as a search, a view, or a purchase\. For a code sample, see [PutEvents Operation](recording-events.md#event-record-api)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/getting-started-python.md |
50f81d5f5a12-0 | After you import your data, create a solution and solution version\. The *solution* contains the configurations to train a model\. A *solution version* is a trained model\. For a code sample, see [Creating a Solution](training-deploying-solutions.md)\.
When you create a solution version, evaluate its performance before proceeding\. For a code sample, see [Evaluating a Solution Version](working-with-training-metrics.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/getting-started-python.md |
de3c8a0e36bf-0 | After you train and evaluate your solution version, you can deploy it using a campaign\. A campaign is an endpoint used to host a solution version and make recommendations to users\. For a code sample, see [Creating a Campaign](campaigns.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/getting-started-python.md |
d05cd528b6e3-0 | After you create a campaign, you can use it to get recommendations\. For a code sample, see [GetRecommendations](getting-real-time-recommendations.md#recommendations)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/getting-started-python.md |
b82edda1990c-0 | To get started using Amazon Personalize using Jupyter notebooks, clone or download a series of notebooks found in the [getting\_started](https://github.com/aws-samples/amazon-personalize-samples/tree/master/getting_started) folder of the [Amazon Personalize Samples](https://github.com/aws-samples/amazon-personalize-samples) repository\. The notebooks walk you through importing training data, creating a solution, creating a campaign, and getting recommendations using Amazon Personalize\.
**Note**
Before starting with the notebooks, make sure to build your environment following the steps in the [README\.md](https://github.com/aws-samples/amazon-personalize-samples/blob/master/getting_started/README.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/getting-started-python.md |
8117af664d8a-0 | If hyperparameter optimization \(HPO\) was performed, contains the hyperparameter values of the best performing model\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_TunedHPOParams.md |
6122fdae7da5-0 | **algorithmHyperParameters** <a name="personalize-Type-TunedHPOParams-algorithmHyperParameters"></a>
A list of the hyperparameter values of the best performing model\.
Type: String to string map
Map Entries: Maximum number of 100 items\.
Key Length Constraints: Maximum length of 256\.
Value Length Constraints: Maximum length of 1000\.
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_TunedHPOParams.md |
ff9f61c226b3-0 | For more information about using this API in one of the language\-specific AWS SDKs, see the following:
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/TunedHPOParams)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/TunedHPOParams)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/TunedHPOParams)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/TunedHPOParams) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_TunedHPOParams.md |
5efa5276f1b7-0 | Provides the name and default range of a continuous hyperparameter and whether the hyperparameter is tunable\. A tunable hyperparameter can have its value determined during hyperparameter optimization \(HPO\)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DefaultContinuousHyperParameterRange.md |
de059e3defcf-0 | **isTunable** <a name="personalize-Type-DefaultContinuousHyperParameterRange-isTunable"></a>
Whether the hyperparameter is tunable\.
Type: Boolean
Required: No
**maxValue** <a name="personalize-Type-DefaultContinuousHyperParameterRange-maxValue"></a>
The maximum allowable value for the hyperparameter\.
Type: Double
Valid Range: Minimum value of \-1000000\.
Required: No
**minValue** <a name="personalize-Type-DefaultContinuousHyperParameterRange-minValue"></a>
The minimum allowable value for the hyperparameter\.
Type: Double
Valid Range: Minimum value of \-1000000\.
Required: No
**name** <a name="personalize-Type-DefaultContinuousHyperParameterRange-name"></a>
The name of the hyperparameter\.
Type: String
Length Constraints: Maximum length of 256\.
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DefaultContinuousHyperParameterRange.md |
9411e9d38c86-0 | For more information about using this API in one of the language\-specific AWS SDKs, see the following:
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DefaultContinuousHyperParameterRange)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/DefaultContinuousHyperParameterRange)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/DefaultContinuousHyperParameterRange)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DefaultContinuousHyperParameterRange) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DefaultContinuousHyperParameterRange.md |
ea970fcf64fb-0 | Provides a summary of the properties of a campaign\. For a complete listing, call the [DescribeCampaign](API_DescribeCampaign.md) API\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CampaignSummary.md |
93222d92ab0e-0 | **campaignArn** <a name="personalize-Type-CampaignSummary-campaignArn"></a>
The Amazon Resource Name \(ARN\) of the campaign\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
**creationDateTime** <a name="personalize-Type-CampaignSummary-creationDateTime"></a>
The date and time \(in Unix time\) that the campaign was created\.
Type: Timestamp
Required: No
**failureReason** <a name="personalize-Type-CampaignSummary-failureReason"></a>
If a campaign fails, the reason behind the failure\.
Type: String
Required: No
**lastUpdatedDateTime** <a name="personalize-Type-CampaignSummary-lastUpdatedDateTime"></a>
The date and time \(in Unix time\) that the campaign was last updated\.
Type: Timestamp
Required: No
**name** <a name="personalize-Type-CampaignSummary-name"></a>
The name of the campaign\.
Type: String
Length Constraints: Minimum length of 1\. Maximum length of 63\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CampaignSummary.md |
93222d92ab0e-1 | The name of the campaign\.
Type: String
Length Constraints: Minimum length of 1\. Maximum length of 63\.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
**status** <a name="personalize-Type-CampaignSummary-status"></a>
The status of the campaign\.
A campaign can be in one of the following states:
+ CREATE PENDING > CREATE IN\_PROGRESS > ACTIVE \-or\- CREATE FAILED
+ DELETE PENDING > DELETE IN\_PROGRESS
Type: String
Length Constraints: Maximum length of 256\.
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CampaignSummary.md |
4b8d6dd32096-0 | For more information about using this API in one of the language\-specific AWS SDKs, see the following:
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/CampaignSummary)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/CampaignSummary)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/CampaignSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/CampaignSummary) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_CampaignSummary.md |
b6b0ab4701cf-0 | Describes a recipe\.
A recipe contains three items:
+ An algorithm that trains a model\.
+ Hyperparameters that govern the training\.
+ Feature transformation information for modifying the input data before training\.
Amazon Personalize provides a set of predefined recipes\. You specify a recipe when you create a solution with the [CreateSolution](API_CreateSolution.md) API\. `CreateSolution` trains a model by using the algorithm in the specified recipe and a training dataset\. The solution, when deployed as a campaign, can provide recommendations using the [GetRecommendations](https://docs.aws.amazon.com/personalize/latest/dg/API_RS_GetRecommendations.html) API\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeRecipe.md |
f2c23cfd54eb-0 | ```
{
"recipeArn": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeRecipe.md |
ccc596f0f242-0 | The request accepts the following data in JSON format\.
** [recipeArn](#API_DescribeRecipe_RequestSyntax) ** <a name="personalize-DescribeRecipe-request-recipeArn"></a>
The Amazon Resource Name \(ARN\) of the recipe to describe\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeRecipe.md |
776fd93812c8-0 | ```
{
"recipe": {
"algorithmArn": "string",
"creationDateTime": number,
"description": "string",
"featureTransformationArn": "string",
"lastUpdatedDateTime": number,
"name": "string",
"recipeArn": "string",
"recipeType": "string",
"status": "string"
}
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeRecipe.md |
2247bcf8754a-0 | If the action is successful, the service sends back an HTTP 200 response\.
The following data is returned in JSON format by the service\.
** [recipe](#API_DescribeRecipe_ResponseSyntax) ** <a name="personalize-DescribeRecipe-response-recipe"></a>
An object that describes the recipe\.
Type: [Recipe](API_Recipe.md) object | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeRecipe.md |
49b2bc44d78c-0 | **InvalidInputException**
Provide a valid value for the field or parameter\.
HTTP Status Code: 400
**ResourceNotFoundException**
Could not find the specified resource\.
HTTP Status Code: 400 | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeRecipe.md |
9702e7eae529-0 | For more information about using this API in one of the language\-specific AWS SDKs, see the following:
+ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/personalize-2018-05-22/DescribeRecipe)
+ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/personalize-2018-05-22/DescribeRecipe)
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeRecipe)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/DescribeRecipe)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/DescribeRecipe)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/personalize-2018-05-22/DescribeRecipe)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeRecipe) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeRecipe.md |
9702e7eae529-1 | + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeRecipe)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeRecipe) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeRecipe.md |
a13324079b6e-0 | Returns a list of recommended items\. The required input depends on the recipe type used to create the solution backing the campaign, as follows:
+ RELATED\_ITEMS \- `itemId` required, `userId` not used
+ USER\_PERSONALIZATION \- `itemId` optional, `userId` required
**Note**
Campaigns that are backed by a solution created using a recipe of type PERSONALIZED\_RANKING use the [GetPersonalizedRanking](API_RS_GetPersonalizedRanking.md) API\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_RS_GetRecommendations.md |
5d8346a553f0-0 | ```
POST /recommendations HTTP/1.1
Content-type: application/json
{
"campaignArn": "string",
"context": {
"string" : "string"
},
"filterArn": "string",
"itemId": "string",
"numResults": number,
"userId": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_RS_GetRecommendations.md |
b392bbe5a98a-0 | The request does not use any URI parameters\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_RS_GetRecommendations.md |
ed66cca33a1c-0 | The request accepts the following data in JSON format\.
** [campaignArn](#API_RS_GetRecommendations_RequestSyntax) ** <a name="personalize-RS_GetRecommendations-request-campaignArn"></a>
The Amazon Resource Name \(ARN\) of the campaign to use for getting recommendations\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes
** [context](#API_RS_GetRecommendations_RequestSyntax) ** <a name="personalize-RS_GetRecommendations-request-context"></a>
The contextual metadata to use when getting recommendations\. Contextual metadata includes any interaction information that might be relevant when getting a user's recommendations, such as the user's current location or device type\.
Type: String to string map
Map Entries: Maximum number of 150 items\.
Key Length Constraints: Maximum length of 150\.
Key Pattern: `[A-Za-z\d_]+`
Value Length Constraints: Maximum length of 1000\.
Required: No
** [filterArn](#API_RS_GetRecommendations_RequestSyntax) ** <a name="personalize-RS_GetRecommendations-request-filterArn"></a> | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_RS_GetRecommendations.md |
ed66cca33a1c-1 | The ARN of the filter to apply to the returned recommendations\. For more information, see [Using Filters with Amazon Personalize](https://docs.aws.amazon.com/personalize/latest/dg/filters.html)\.
When using this parameter, be sure the filter resource is `ACTIVE`\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
** [itemId](#API_RS_GetRecommendations_RequestSyntax) ** <a name="personalize-RS_GetRecommendations-request-itemId"></a>
The item ID to provide recommendations for\.
Required for `RELATED_ITEMS` recipe type\.
Type: String
Length Constraints: Maximum length of 256\.
Required: No
** [numResults](#API_RS_GetRecommendations_RequestSyntax) ** <a name="personalize-RS_GetRecommendations-request-numResults"></a>
The number of results to return\. The default is 25\. The maximum is 500\.
Type: Integer
Valid Range: Minimum value of 0\.
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_RS_GetRecommendations.md |
ed66cca33a1c-2 | Type: Integer
Valid Range: Minimum value of 0\.
Required: No
** [userId](#API_RS_GetRecommendations_RequestSyntax) ** <a name="personalize-RS_GetRecommendations-request-userId"></a>
The user ID to provide recommendations for\.
Required for `USER_PERSONALIZATION` recipe type\.
Type: String
Length Constraints: Maximum length of 256\.
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_RS_GetRecommendations.md |
dd2a7ecdec92-0 | ```
HTTP/1.1 200
Content-type: application/json
{
"itemList": [
{
"itemId": "string",
"score": number
}
],
"recommendationId": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_RS_GetRecommendations.md |
e881c9e1ae6c-0 | If the action is successful, the service sends back an HTTP 200 response\.
The following data is returned in JSON format by the service\.
** [itemList](#API_RS_GetRecommendations_ResponseSyntax) ** <a name="personalize-RS_GetRecommendations-response-itemList"></a>
A list of recommendations sorted in ascending order by prediction score\. There can be a maximum of 500 items in the list\.
Type: Array of [PredictedItem](API_RS_PredictedItem.md) objects
** [recommendationId](#API_RS_GetRecommendations_ResponseSyntax) ** <a name="personalize-RS_GetRecommendations-response-recommendationId"></a>
The ID of the recommendation\.
Type: String | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_RS_GetRecommendations.md |
b6985a9d8cfe-0 | **InvalidInputException**
Provide a valid value for the field or parameter\.
HTTP Status Code: 400
**ResourceNotFoundException**
The specified resource does not exist\.
HTTP Status Code: 404 | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_RS_GetRecommendations.md |
6106585f08ba-0 | For more information about using this API in one of the language\-specific AWS SDKs, see the following:
+ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/personalize-runtime-2018-05-22/GetRecommendations)
+ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/personalize-runtime-2018-05-22/GetRecommendations)
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-runtime-2018-05-22/GetRecommendations)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-runtime-2018-05-22/GetRecommendations)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-runtime-2018-05-22/GetRecommendations)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/personalize-runtime-2018-05-22/GetRecommendations) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_RS_GetRecommendations.md |
6106585f08ba-1 | + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-runtime-2018-05-22/GetRecommendations)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-runtime-2018-05-22/GetRecommendations)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-runtime-2018-05-22/GetRecommendations) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_RS_GetRecommendations.md |
62c19994e89e-0 | Describes the dataset import job created by [CreateDatasetImportJob](API_CreateDatasetImportJob.md), including the import job status\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeDatasetImportJob.md |
2404d9439b32-0 | ```
{
"datasetImportJobArn": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeDatasetImportJob.md |
7d687267912c-0 | The request accepts the following data in JSON format\.
** [datasetImportJobArn](#API_DescribeDatasetImportJob_RequestSyntax) ** <a name="personalize-DescribeDatasetImportJob-request-datasetImportJobArn"></a>
The Amazon Resource Name \(ARN\) of the dataset import job to describe\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeDatasetImportJob.md |
c626d8cb81d0-0 | ```
{
"datasetImportJob": {
"creationDateTime": number,
"datasetArn": "string",
"datasetImportJobArn": "string",
"dataSource": {
"dataLocation": "string"
},
"failureReason": "string",
"jobName": "string",
"lastUpdatedDateTime": number,
"roleArn": "string",
"status": "string"
}
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeDatasetImportJob.md |
bce2f90ba069-0 | If the action is successful, the service sends back an HTTP 200 response\.
The following data is returned in JSON format by the service\.
** [datasetImportJob](#API_DescribeDatasetImportJob_ResponseSyntax) ** <a name="personalize-DescribeDatasetImportJob-response-datasetImportJob"></a>
Information about the dataset import job, including the status\.
The status is one of the following values:
+ CREATE PENDING
+ CREATE IN\_PROGRESS
+ ACTIVE
+ CREATE FAILED
Type: [DatasetImportJob](API_DatasetImportJob.md) object | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeDatasetImportJob.md |
e78c22668911-0 | **InvalidInputException**
Provide a valid value for the field or parameter\.
HTTP Status Code: 400
**ResourceNotFoundException**
Could not find the specified resource\.
HTTP Status Code: 400 | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeDatasetImportJob.md |
cf5fb2cc6c56-0 | For more information about using this API in one of the language\-specific AWS SDKs, see the following:
+ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/personalize-2018-05-22/DescribeDatasetImportJob)
+ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/personalize-2018-05-22/DescribeDatasetImportJob)
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeDatasetImportJob)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/DescribeDatasetImportJob)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/DescribeDatasetImportJob)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/personalize-2018-05-22/DescribeDatasetImportJob) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeDatasetImportJob.md |
cf5fb2cc6c56-1 | + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeDatasetImportJob)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeDatasetImportJob)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeDatasetImportJob) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeDatasetImportJob.md |
84c80231ce2e-0 | Specifies the hyperparameters and their ranges\. Hyperparameters can be categorical, continuous, or integer\-valued\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_HyperParameterRanges.md |
2a58aa7c9956-0 | **categoricalHyperParameterRanges** <a name="personalize-Type-HyperParameterRanges-categoricalHyperParameterRanges"></a>
The categorical hyperparameters and their ranges\.
Type: Array of [CategoricalHyperParameterRange](API_CategoricalHyperParameterRange.md) objects
Array Members: Maximum number of 100 items\.
Required: No
**continuousHyperParameterRanges** <a name="personalize-Type-HyperParameterRanges-continuousHyperParameterRanges"></a>
The continuous hyperparameters and their ranges\.
Type: Array of [ContinuousHyperParameterRange](API_ContinuousHyperParameterRange.md) objects
Array Members: Maximum number of 100 items\.
Required: No
**integerHyperParameterRanges** <a name="personalize-Type-HyperParameterRanges-integerHyperParameterRanges"></a>
The integer\-valued hyperparameters and their ranges\.
Type: Array of [IntegerHyperParameterRange](API_IntegerHyperParameterRange.md) objects
Array Members: Maximum number of 100 items\.
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_HyperParameterRanges.md |
e14a890811d5-0 | For more information about using this API in one of the language\-specific AWS SDKs, see the following:
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/HyperParameterRanges)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/HyperParameterRanges)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/HyperParameterRanges)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/HyperParameterRanges) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_HyperParameterRanges.md |
5355b0e67f15-0 | Describes the given dataset group\. For more information on dataset groups, see [CreateDatasetGroup](API_CreateDatasetGroup.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeDatasetGroup.md |
5d1020caa3a4-0 | ```
{
"datasetGroupArn": "string"
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeDatasetGroup.md |
6b81cba98fa2-0 | The request accepts the following data in JSON format\.
** [datasetGroupArn](#API_DescribeDatasetGroup_RequestSyntax) ** <a name="personalize-DescribeDatasetGroup-request-datasetGroupArn"></a>
The Amazon Resource Name \(ARN\) of the dataset group to describe\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: Yes | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeDatasetGroup.md |
8027baae4ca1-0 | ```
{
"datasetGroup": {
"creationDateTime": number,
"datasetGroupArn": "string",
"failureReason": "string",
"kmsKeyArn": "string",
"lastUpdatedDateTime": number,
"name": "string",
"roleArn": "string",
"status": "string"
}
}
``` | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeDatasetGroup.md |
9ebd7c83756d-0 | If the action is successful, the service sends back an HTTP 200 response\.
The following data is returned in JSON format by the service\.
** [datasetGroup](#API_DescribeDatasetGroup_ResponseSyntax) ** <a name="personalize-DescribeDatasetGroup-response-datasetGroup"></a>
A listing of the dataset group's properties\.
Type: [DatasetGroup](API_DatasetGroup.md) object | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeDatasetGroup.md |
c3fd4b12b4e2-0 | **InvalidInputException**
Provide a valid value for the field or parameter\.
HTTP Status Code: 400
**ResourceNotFoundException**
Could not find the specified resource\.
HTTP Status Code: 400 | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeDatasetGroup.md |
a0f5d268f1ea-0 | For more information about using this API in one of the language\-specific AWS SDKs, see the following:
+ [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/personalize-2018-05-22/DescribeDatasetGroup)
+ [AWS SDK for \.NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/personalize-2018-05-22/DescribeDatasetGroup)
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/DescribeDatasetGroup)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/DescribeDatasetGroup)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/DescribeDatasetGroup)
+ [AWS SDK for JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/personalize-2018-05-22/DescribeDatasetGroup)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/personalize-2018-05-22/DescribeDatasetGroup) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeDatasetGroup.md |
a0f5d268f1ea-1 | + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/personalize-2018-05-22/DescribeDatasetGroup)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/DescribeDatasetGroup) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_DescribeDatasetGroup.md |
a8ffa23046f5-0 | Provides the name and range of a continuous hyperparameter\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ContinuousHyperParameterRange.md |
f8696e075f01-0 | **maxValue** <a name="personalize-Type-ContinuousHyperParameterRange-maxValue"></a>
The maximum allowable value for the hyperparameter\.
Type: Double
Valid Range: Minimum value of \-1000000\.
Required: No
**minValue** <a name="personalize-Type-ContinuousHyperParameterRange-minValue"></a>
The minimum allowable value for the hyperparameter\.
Type: Double
Valid Range: Minimum value of \-1000000\.
Required: No
**name** <a name="personalize-Type-ContinuousHyperParameterRange-name"></a>
The name of the hyperparameter\.
Type: String
Length Constraints: Maximum length of 256\.
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ContinuousHyperParameterRange.md |
00a09fb61ce2-0 | For more information about using this API in one of the language\-specific AWS SDKs, see the following:
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/ContinuousHyperParameterRange)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/ContinuousHyperParameterRange)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/ContinuousHyperParameterRange)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/ContinuousHyperParameterRange) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_ContinuousHyperParameterRange.md |
2a2eb1abc583-0 | An object that provides information about a solution\. A solution is a trained model that can be deployed as a campaign\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_Solution.md |
afa61c9955f9-0 | **autoMLResult** <a name="personalize-Type-Solution-autoMLResult"></a>
When `performAutoML` is true, specifies the best recipe found\.
Type: [AutoMLResult](API_AutoMLResult.md) object
Required: No
**creationDateTime** <a name="personalize-Type-Solution-creationDateTime"></a>
The creation date and time \(in Unix time\) of the solution\.
Type: Timestamp
Required: No
**datasetGroupArn** <a name="personalize-Type-Solution-datasetGroupArn"></a>
The Amazon Resource Name \(ARN\) of the dataset group that provides the training data\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
**eventType** <a name="personalize-Type-Solution-eventType"></a>
The event type \(for example, 'click' or 'like'\) that is used for training the model\. If no `eventType` is provided, Amazon Personalize uses all interactions for training with equal weight regardless of type\.
Type: String
Length Constraints: Maximum length of 256\.
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_Solution.md |
afa61c9955f9-1 | Type: String
Length Constraints: Maximum length of 256\.
Required: No
**lastUpdatedDateTime** <a name="personalize-Type-Solution-lastUpdatedDateTime"></a>
The date and time \(in Unix time\) that the solution was last updated\.
Type: Timestamp
Required: No
**latestSolutionVersion** <a name="personalize-Type-Solution-latestSolutionVersion"></a>
Describes the latest version of the solution, including the status and the ARN\.
Type: [SolutionVersionSummary](API_SolutionVersionSummary.md) object
Required: No
**name** <a name="personalize-Type-Solution-name"></a>
The name of the solution\.
Type: String
Length Constraints: Minimum length of 1\. Maximum length of 63\.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
**performAutoML** <a name="personalize-Type-Solution-performAutoML"></a>
When true, Amazon Personalize performs a search for the best USER\_PERSONALIZATION recipe from the list specified in the solution configuration \(`recipeArn` must not be specified\)\. When false \(the default\), Amazon Personalize uses `recipeArn` for training\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_Solution.md |
afa61c9955f9-2 | Type: Boolean
Required: No
**performHPO** <a name="personalize-Type-Solution-performHPO"></a>
Whether to perform hyperparameter optimization \(HPO\) on the chosen recipe\. The default is `false`\.
Type: Boolean
Required: No
**recipeArn** <a name="personalize-Type-Solution-recipeArn"></a>
The ARN of the recipe used to create the solution\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
**solutionArn** <a name="personalize-Type-Solution-solutionArn"></a>
The ARN of the solution\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
**solutionConfig** <a name="personalize-Type-Solution-solutionConfig"></a>
Describes the configuration properties for the solution\.
Type: [SolutionConfig](API_SolutionConfig.md) object
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_Solution.md |
afa61c9955f9-3 | Type: [SolutionConfig](API_SolutionConfig.md) object
Required: No
**status** <a name="personalize-Type-Solution-status"></a>
The status of the solution\.
A solution can be in one of the following states:
+ CREATE PENDING > CREATE IN\_PROGRESS > ACTIVE \-or\- CREATE FAILED
+ DELETE PENDING > DELETE IN\_PROGRESS
Type: String
Length Constraints: Maximum length of 256\.
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_Solution.md |
2c8eade2cdf0-0 | For more information about using this API in one of the language\-specific AWS SDKs, see the following:
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/Solution)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/Solution)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/Solution)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/Solution) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_Solution.md |
04f784a63816-0 | AWS Identity and Access Management \(IAM\) is an AWS service that helps an administrator securely control access to AWS resources\. IAM administrators control who can be *authenticated* \(signed in\) and *authorized* \(have permissions\) to use Amazon Personalize resources\. IAM is an AWS service that you can use with no additional charge\.
**Topics**
+ [Audience](#security_iam_audience)
+ [Authenticating With Identities](#security_iam_authentication)
+ [Managing Access Using Policies](#security_iam_access-manage)
+ [How Amazon Personalize Works with IAM](security_iam_service-with-iam.md)
+ [Amazon Personalize Identity\-Based Policy Examples](security_iam_id-based-policy-examples.md)
+ [Troubleshooting Amazon Personalize Identity and Access](security_iam_troubleshoot.md) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security-iam.md |
84b30e334d2e-0 | How you use AWS Identity and Access Management \(IAM\) differs, depending on the work you do in Amazon Personalize\.
**Service user** – If you use the Amazon Personalize service to do your job, then your administrator provides you with the credentials and permissions that you need\. As you use more Amazon Personalize features to do your work, you might need additional permissions\. Understanding how access is managed can help you request the right permissions from your administrator\. If you cannot access a feature in Amazon Personalize, see [Troubleshooting Amazon Personalize Identity and Access](security_iam_troubleshoot.md)\.
**Service administrator** – If you're in charge of Amazon Personalize resources at your company, you probably have full access to Amazon Personalize\. It's your job to determine which Amazon Personalize features and resources your employees should access\. You must then submit requests to your IAM administrator to change the permissions of your service users\. Review the information on this page to understand the basic concepts of IAM\. To learn more about how your company can use IAM with Amazon Personalize, see [How Amazon Personalize Works with IAM](security_iam_service-with-iam.md)\.
**IAM administrator** – If you're an IAM administrator, you might want to learn details about how you can write policies to manage access to Amazon Personalize\. To view example Amazon Personalize identity\-based policies that you can use in IAM, see [Amazon Personalize Identity\-Based Policy Examples](security_iam_id-based-policy-examples.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security-iam.md |
5b32a4640fe5-0 | Authentication is how you sign in to AWS using your identity credentials\. For more information about signing in using the AWS Management Console, see [The IAM Console and Sign\-in Page](https://docs.aws.amazon.com/IAM/latest/UserGuide/console.html) in the *IAM User Guide*\.
You must be *authenticated* \(signed in to AWS\) as the AWS account root user, an IAM user, or by assuming an IAM role\. You can also use your company's single sign\-on authentication, or even sign in using Google or Facebook\. In these cases, your administrator previously set up identity federation using IAM roles\. When you access AWS using credentials from another company, you are assuming a role indirectly\.
To sign in directly to the [AWS Management Console](https://console.aws.amazon.com/), use your password with your root user email or your IAM user name\. You can access AWS programmatically using your root user or IAM user access keys\. AWS provides SDK and command line tools to cryptographically sign your request using your credentials\. If you don’t use AWS tools, you must sign the request yourself\. Do this using *Signature Version 4*, a protocol for authenticating inbound API requests\. For more information about authenticating requests, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *AWS General Reference*\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security-iam.md |
5b32a4640fe5-1 | Regardless of the authentication method that you use, you might also be required to provide additional security information\. For example, AWS recommends that you use multi\-factor authentication \(MFA\) to increase the security of your account\. To learn more, see [Using Multi\-Factor Authentication \(MFA\) in AWS](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_mfa.html) in the *IAM User Guide*\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security-iam.md |
52521817bed8-0 | When you first create an AWS account, you begin with a single sign\-in identity that has complete access to all AWS services and resources in the account\. This identity is called the AWS account *root user* and is accessed by signing in with the email address and password that you used to create the account\. We strongly recommend that you do not use the root user for your everyday tasks, even the administrative ones\. Instead, adhere to | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security-iam.md |
52521817bed8-1 | even the administrative ones\. Instead, adhere to the [best practice of using the root user only to create your first IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/best-practices.html#create-iam-users)\. Then securely lock away the root user credentials and use them to perform only a few account and service management tasks\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security-iam.md |
55ddf1ff7de1-0 | An *[IAM user](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html)* is an identity within your AWS account that has specific permissions for a single person or application\. An IAM user can have long\-term credentials such as a user name and password or a set of access keys\. To learn how to generate access keys, see [Managing Access Keys for IAM Users](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html) in the *IAM User Guide*\. When you generate access keys for an IAM user, make sure you view and securely save the key pair\. You cannot recover the secret access key in the future\. Instead, you must generate a new access key pair\.
An [https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups.html](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_groups.html) is an identity that specifies a collection of IAM users\. You can't sign in as a group\. You can use groups to specify permissions for multiple users at a time\. Groups make permissions easier to manage for large sets of users\. For example, you could have a group named *IAMAdmins* and give that group permissions to administer IAM resources\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security-iam.md |
55ddf1ff7de1-1 | Users are different from roles\. A user is uniquely associated with one person or application, but a role is intended to be assumable by anyone who needs it\. Users have permanent long\-term credentials, but roles provide temporary credentials\. To learn more, see [When to Create an IAM User \(Instead of a Role\)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id.html#id_which-to-choose) in the *IAM User Guide*\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security-iam.md |
97c1c4a14feb-0 | An *[IAM role](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles.html)* is an identity within your AWS account that has specific permissions\. It is similar to an IAM user, but is not associated with a specific person\. You can temporarily assume an IAM role in the AWS Management Console by [switching roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-console.html)\. You can assume a role by calling an AWS CLI or AWS API operation or by using a custom URL\. For more information about methods for using roles, see [Using IAM Roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html) in the *IAM User Guide*\.
IAM roles with temporary credentials are useful in the following situations:
+ **Temporary IAM user permissions** – An IAM user can assume an IAM role to temporarily take on different permissions for a specific task\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security-iam.md |
97c1c4a14feb-1 | + **Temporary IAM user permissions** – An IAM user can assume an IAM role to temporarily take on different permissions for a specific task\.
+ **Federated user access** – Instead of creating an IAM user, you can use existing identities from AWS Directory Service, your enterprise user directory, or a web identity provider\. These are known as *federated users*\. AWS assigns a role to a federated user when access is requested through an [identity provider](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers.html)\. For more information about federated users, see [Federated Users and Roles](https://docs.aws.amazon.com/IAM/latest/UserGuide/introduction_access-management.html#intro-access-roles) in the *IAM User Guide*\.
+ **Cross\-account access** – You can use an IAM role to allow someone \(a trusted principal\) in a different account to access resources in your account\. Roles are the primary way to grant cross\-account access\. However, with some AWS services, you can attach a policy directly to a resource \(instead of using a role as a proxy\)\. To learn the difference between roles and resource\-based policies for cross\-account access, see [How IAM Roles Differ from Resource\-based Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_compare-resource-policies.html) in the *IAM User Guide*\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security-iam.md |
97c1c4a14feb-2 | + **AWS service access** – A service role is an IAM role that a service assumes to perform actions in your account on your behalf\. When you set up some AWS service environments, you must define a role for the service to assume\. This service role must include all the permissions that are required for the service to access the AWS resources that it needs\. Service roles vary from service to service, but many allow you to choose your permissions as long as you meet the documented requirements for that service\. Service roles provide access only within your account and cannot be used to grant access to services in other accounts\. You can create, modify, and delete a service role from within IAM\. For example, you can create a role that allows Amazon Redshift to access an Amazon S3 bucket on your behalf and then load data from that bucket into an Amazon Redshift cluster\. For more information, see [Creating a Role to Delegate Permissions to an AWS Service](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-service.html) in the *IAM User Guide*\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security-iam.md |
97c1c4a14feb-3 | + **Applications running on Amazon EC2** – You can use an IAM role to manage temporary credentials for applications that are running on an EC2 instance and making AWS CLI or AWS API requests\. This is preferable to storing access keys within the EC2 instance\. To assign an AWS role to an EC2 instance and make it available to all of its applications, you create an instance profile that is attached to the instance\. An instance profile contains the role and enables programs that are running on the EC2 instance to get temporary credentials\. For more information, see [Using an IAM Role to Grant Permissions to Applications Running on Amazon EC2 Instances](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html) in the *IAM User Guide*\.
To learn whether to use IAM roles, see [When to Create an IAM Role \(Instead of a User\)](https://docs.aws.amazon.com/IAM/latest/UserGuide/id.html#id_which-to-choose_role) in the *IAM User Guide*\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security-iam.md |
d98916cacaed-0 | You control access in AWS by creating policies and attaching them to IAM identities or AWS resources\. A policy is an object in AWS that, when associated with an identity or resource, defines their permissions\. AWS evaluates these policies when an entity \(root user, IAM user, or IAM role\) makes a request\. Permissions in the policies determine whether the request is allowed or denied\. Most policies are stored in AWS as JSON documents\. For more information about the structure and contents of JSON policy documents, see [Overview of JSON Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json) in the *IAM User Guide*\.
An IAM administrator can use policies to specify who has access to AWS resources, and what actions they can perform on those resources\. Every IAM entity \(user or role\) starts with no permissions\. In other words, by default, users can do nothing, not even change their own password\. To give a user permission to do something, an administrator must attach a permissions policy to a user\. Or the administrator can add the user to a group that has the intended permissions\. When an administrator gives permissions to a group, all users in that group are granted those permissions\.
IAM policies define permissions for an action regardless of the method that you use to perform the operation\. For example, suppose that you have a policy that allows the `iam:GetRole` action\. A user with that policy can get role information from the AWS Management Console, the AWS CLI, or the AWS API\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security-iam.md |
570aea3c3ccd-0 | Identity\-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, role, or group\. These policies control what actions that identity can perform, on which resources, and under what conditions\. To learn how to create an identity\-based policy, see [Creating IAM Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_create.html) in the *IAM User Guide*\.
Identity\-based policies can be further categorized as *inline policies* or *managed policies*\. Inline policies are embedded directly into a single user, group, or role\. Managed policies are standalone policies that you can attach to multiple users, groups, and roles in your AWS account\. Managed policies include AWS managed policies and customer managed policies\. To learn how to choose between a managed policy or an inline policy, see [Choosing Between Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_managed-vs-inline.html#choosing-managed-or-inline) in the *IAM User Guide*\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security-iam.md |
436d6e536f56-0 | Resource\-based policies are JSON policy documents that you attach to a resource such as an Amazon S3 bucket\. Service administrators can use these policies to define what actions a specified principal \(account member, user, or role\) can perform on that resource and under what conditions\. Resource\-based policies are inline policies\. There are no managed resource\-based policies\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security-iam.md |
e307c931c944-0 | Access control lists \(ACLs\) are a type of policy that controls which principals \(account members, users, or roles\) have permissions to access a resource\. ACLs are similar to resource\-based policies, although they do not use the JSON policy document format\. Amazon S3, AWS WAF, and Amazon VPC are examples of services that support ACLs\. To learn more about ACLs, see [Access Control List \(ACL\) Overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) in | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security-iam.md |
e307c931c944-1 | Overview](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) in the *Amazon Simple Storage Service Developer Guide*\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security-iam.md |
81badaa9984d-0 | AWS supports additional, less\-common policy types\. These policy types can set the maximum permissions granted to you by the more common policy types\.
+ **Permissions boundaries** – A permissions boundary is an advanced feature in which you set the maximum permissions that an identity\-based policy can grant to an IAM entity \(IAM user or role\)\. You can set a permissions boundary for an entity\. The resulting permissions are the intersection of entity's identity\-based policies and its permissions boundaries\. Resource\-based policies that specify the user or role in the `Principal` field are not limited by the permissions boundary\. An explicit deny in any of these policies overrides the allow\. For more information about permissions boundaries, see [Permissions Boundaries for IAM Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security-iam.md |
81badaa9984d-1 | + **Service control policies \(SCPs\)** – SCPs are JSON policies that specify the maximum permissions for an organization or organizational unit \(OU\) in AWS Organizations\. AWS Organizations is a service for grouping and centrally managing multiple AWS accounts that your business owns\. If you enable all features in an organization, then you can apply service control policies \(SCPs\) to any or all of your accounts\. The SCP limits permissions for entities in member accounts, including each AWS account root user\. For more information about Organizations and SCPs, see [How SCPs Work](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_about-scps.html) in the *AWS Organizations User Guide*\.
+ **Session policies** – Session policies are advanced policies that you pass as a parameter when you programmatically create a temporary session for a role or federated user\. The resulting session's permissions are the intersection of the user or role's identity\-based policies and the session policies\. Permissions can also come from a resource\-based policy\. An explicit deny in any of these policies overrides the allow\. For more information, see [Session Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#policies_session) in the *IAM User Guide*\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security-iam.md |
bed5d2cc9a4b-0 | When multiple types of policies apply to a request, the resulting permissions are more complicated to understand\. To learn how AWS determines whether to allow a request when multiple policy types are involved, see [Policy Evaluation Logic](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_evaluation-logic.html) in the *IAM User Guide*\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/security-iam.md |
d64b149dca08-0 | Provides a summary of the properties of an event tracker\. For a complete listing, call the [DescribeEventTracker](API_DescribeEventTracker.md) API\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_EventTrackerSummary.md |
8dc09f383798-0 | **creationDateTime** <a name="personalize-Type-EventTrackerSummary-creationDateTime"></a>
The date and time \(in Unix time\) that the event tracker was created\.
Type: Timestamp
Required: No
**eventTrackerArn** <a name="personalize-Type-EventTrackerSummary-eventTrackerArn"></a>
The Amazon Resource Name \(ARN\) of the event tracker\.
Type: String
Length Constraints: Maximum length of 256\.
Pattern: `arn:([a-z\d-]+):personalize:.*:.*:.+`
Required: No
**lastUpdatedDateTime** <a name="personalize-Type-EventTrackerSummary-lastUpdatedDateTime"></a>
The date and time \(in Unix time\) that the event tracker was last updated\.
Type: Timestamp
Required: No
**name** <a name="personalize-Type-EventTrackerSummary-name"></a>
The name of the event tracker\.
Type: String
Length Constraints: Minimum length of 1\. Maximum length of 63\.
Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_EventTrackerSummary.md |
8dc09f383798-1 | Pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]*`
Required: No
**status** <a name="personalize-Type-EventTrackerSummary-status"></a>
The status of the event tracker\.
An event tracker can be in one of the following states:
+ CREATE PENDING > CREATE IN\_PROGRESS > ACTIVE \-or\- CREATE FAILED
+ DELETE PENDING > DELETE IN\_PROGRESS
Type: String
Length Constraints: Maximum length of 256\.
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_EventTrackerSummary.md |
ee2f76c0cc40-0 | For more information about using this API in one of the language\-specific AWS SDKs, see the following:
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/EventTrackerSummary)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/EventTrackerSummary)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/EventTrackerSummary)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/EventTrackerSummary) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_EventTrackerSummary.md |
4cc66557038e-0 | To import your training data into Amazon Personalize, first create an empty dataset group and then an empty dataset in that dataset group\. Next, create an import job that populates the dataset with data from your Amazon S3 bucket\. For more information about datasets, see [Datasets and Schemas](how-it-works-dataset-schema.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/data-prep-importing.md |
15d17ba51111-0 | The following steps show how to create and populate a dataset\. For the equivalent steps using the AWS CLI, see [Step 1: Import Training Data](getting-started-cli.md#gs-create-ds)\.
1. Create a dataset group using the [CreateDatasetGroup](API_CreateDatasetGroup.md) API\.
```
import boto3
personalize = boto3.client('personalize')
response = personalize.create_dataset_group(name = 'YourDatasetGroup')
dsg_arn = response['datasetGroupArn']
description = personalize.describe_dataset_group(datasetGroupArn = dsg_arn)['datasetGroup']
print('Name: ' + description['name'])
print('ARN: ' + description['datasetGroupArn'])
print('Status: ' + description['status'])
```
The response from the [DescribeDatasetGroup](API_DescribeDatasetGroup.md) API returns the `datasetGroupArn` and the status of the operation\.
**Note**
You must wait until the status shows as ACTIVE before you can proceed to the next step\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/data-prep-importing.md |
15d17ba51111-1 | **Note**
You must wait until the status shows as ACTIVE before you can proceed to the next step\.
1. Create a dataset using the [CreateDataset](API_CreateDataset.md) API\. Specify the `datasetGroupArn` returned in the previous step\. Use the `schemaArn` created earlier in [Datasets and Schemas](how-it-works-dataset-schema.md)\.
```
import boto3
personalize = boto3.client('personalize')
response = personalize.create_dataset(
name = 'YourDataset',
schemaArn = 'schema_arn',
datasetGroupArn = 'dataset_group_arn',
datasetType = 'Interactions')
print ('Dataset Arn: ' + response['datasetArn'])
```
1. To add data to your dataset, create and run a dataset import job using the [CreateDatasetImportJob](API_CreateDatasetImportJob.md) API\. Specify the `datasetGroupArn` and set the `dataLocation` to the `bucket-name/file.csv` where you stored the training data\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/data-prep-importing.md |
15d17ba51111-2 | You can upload multiple CSV files to a dataset in one dataset import job if your CSV files are in a folder in the Amazon S3 bucket\. For `dataLocation`, specify the `bucket-name/folder-name/` instead of the file name\.
For the `roleArn`, see [Creating an IAM Role for Amazon Personalize](aws-personalize-set-up-permissions.md#set-up-create-role-with-permissions)\. The `roleArn` parameter specifies the AWS Identity and Access Management \(IAM\) role that gives Amazon Personalize permissions to access your S3 bucket\.
```
import boto3
personalize = boto3.client('personalize')
response = personalize.create_dataset_import_job(
jobName = 'YourImportJob',
datasetArn = 'dataset_arn',
dataSource = {'dataLocation':'s3://bucket/file.csv'},
roleArn = 'role_arn')
dsij_arn = response['datasetImportJobArn']
print ('Dataset Import Job arn: ' + dsij_arn)
description = personalize.describe_dataset_import_job(
datasetImportJobArn = dsij_arn)['datasetImportJob']
print('Name: ' + description['jobName']) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/data-prep-importing.md |
15d17ba51111-3 | print('Name: ' + description['jobName'])
print('ARN: ' + description['datasetImportJobArn'])
print('Status: ' + description['status'])
```
The response returns the `datasetImportJobArn`\. The response from the [DescribeDatasetImportJob](API_DescribeDatasetImportJob.md) API includes the status of the operation\.
**Note**
You must wait until the status changes to ACTIVE before you can use the data to train a model\.
**Important**
Imports in Amazon Personalize are a full refresh of the data\. You can't add incremental updates\. If you need to update your data, import the complete updated file\.
Amazon Personalize provides operations for managing datasets, dataset groups, and dataset import jobs\. For example, you can use [ListDatasets](API_ListDatasets.md) to list the datasets in a dataset group and use [DeleteDataset](API_DeleteDataset.md) to delete a dataset\.
After you import your data into the relevant datasets in the dataset group, create a solution version by training a model\. For more information, see [Creating a Solution](training-deploying-solutions.md)\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/data-prep-importing.md |
9924e4d19521-0 | The configuration details of a batch inference job\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_BatchInferenceJobConfig.md |
f0cd136cb681-0 | **itemExplorationConfig** <a name="personalize-Type-BatchInferenceJobConfig-itemExplorationConfig"></a>
A string to string map specifying the exploration configuration hyperparameters, including `explorationWeight` and `explorationItemAgeCutOff`, you want to use to configure the amount of item exploration Amazon Personalize uses when recommending items\. See [User\-Personalization Recipe](native-recipe-new-item-USER_PERSONALIZATION.md)\.
Type: String to string map
Map Entries: Maximum number of 100 items\.
Key Length Constraints: Maximum length of 256\.
Value Length Constraints: Maximum length of 1000\.
Required: No | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_BatchInferenceJobConfig.md |
200ef41903ee-0 | For more information about using this API in one of the language\-specific AWS SDKs, see the following:
+ [AWS SDK for C\+\+](https://docs.aws.amazon.com/goto/SdkForCpp/personalize-2018-05-22/BatchInferenceJobConfig)
+ [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/personalize-2018-05-22/BatchInferenceJobConfig)
+ [AWS SDK for Java](https://docs.aws.amazon.com/goto/SdkForJava/personalize-2018-05-22/BatchInferenceJobConfig)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/personalize-2018-05-22/BatchInferenceJobConfig) | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_BatchInferenceJobConfig.md |
3c4ce8f5b8ea-0 | The input configuration of a batch inference job\. | https://github.com/siagholami/aws-documentation/tree/main/documents/amazon-personalize-developer-guide/doc_source/API_BatchInferenceJobInput.md |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.