Rekognition / Client / get_celebrity_info

get_celebrity_info#

Rekognition.Client.get_celebrity_info(**kwargs)#

Gets the name and additional information about a celebrity based on their Amazon Rekognition ID. The additional information is returned as an array of URLs. If there is no additional information about the celebrity, this list is empty.

For more information, see Getting information about a celebrity in the Amazon Rekognition Developer Guide.

This operation requires permissions to perform the rekognition:GetCelebrityInfo action.

Request Syntax

response = client.get_celebrity_info(
    Id='string'
)

Parameters:

Id (string) –

[REQUIRED]

The ID for the celebrity. You get the celebrity ID from a call to the RecognizeCelebrities operation, which recognizes celebrities in an image.

Return type:

dict

Returns:

Response Syntax

{
    'Urls': [
        'string',
    ],
    'Name': 'string',
    'KnownGender': {
        'Type': 'Male'|'Female'|'Nonbinary'|'Unlisted'
    }
}

Response Structure

(dict) –
- Urls (list) –
  
  An array of URLs pointing to additional celebrity information.
  - (string) –
- Name (string) –
  
  The name of the celebrity.
- KnownGender (dict) –
  
  Retrieves the known gender for the celebrity.
  - Type (string) –
    
    A string value of the KnownGender info about the Celebrity.

Exceptions

Rekognition.Client.exceptions.InvalidParameterException
Rekognition.Client.exceptions.AccessDeniedException
Rekognition.Client.exceptions.InternalServerError
Rekognition.Client.exceptions.ThrottlingException
Rekognition.Client.exceptions.ProvisionedThroughputExceededException
Rekognition.Client.exceptions.ResourceNotFoundException