RekognitionClient

Index > Rekognition > RekognitionClient

Auto-generated documentation for Rekognition type annotations stubs module mypy-boto3-rekognition.

RekognitionClient

Type annotations and code completion for boto3.client("rekognition"). boto3 documentation

# RekognitionClient usage example

from boto3.session import Session
from mypy_boto3_rekognition.client import RekognitionClient

def get_rekognition_client() -> RekognitionClient:
    return Session().client("rekognition")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("rekognition").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("rekognition")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.HumanLoopQuotaExceededException,
    client.exceptions.IdempotentParameterMismatchException,
    client.exceptions.ImageTooLargeException,
    client.exceptions.InternalServerError,
    client.exceptions.InvalidImageFormatException,
    client.exceptions.InvalidManifestException,
    client.exceptions.InvalidPaginationTokenException,
    client.exceptions.InvalidParameterException,
    client.exceptions.InvalidPolicyRevisionIdException,
    client.exceptions.InvalidS3ObjectException,
    client.exceptions.LimitExceededException,
    client.exceptions.MalformedPolicyDocumentException,
    client.exceptions.ProvisionedThroughputExceededException,
    client.exceptions.ResourceAlreadyExistsException,
    client.exceptions.ResourceInUseException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ResourceNotReadyException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.SessionNotFoundException,
    client.exceptions.ThrottlingException,
    client.exceptions.VideoTooLargeException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_rekognition.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Type annotations and code completion for boto3.client("rekognition").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

generate_presigned_url

Type annotations and code completion for boto3.client("rekognition").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

associate_faces

Associates one or more faces with an existing UserID.

Type annotations and code completion for boto3.client("rekognition").associate_faces method. boto3 documentation

# associate_faces method definition

def associate_faces(
    self,
    *,
    CollectionId: str,
    UserId: str,
    FaceIds: Sequence[str],
    UserMatchThreshold: float = ...,
    ClientRequestToken: str = ...,
) -> AssociateFacesResponseTypeDef:  # (1)
    ...

1. See AssociateFacesResponseTypeDef

# associate_faces method usage example with argument unpacking

kwargs: AssociateFacesRequestTypeDef = {  # (1)
    "CollectionId": ...,
    "UserId": ...,
    "FaceIds": ...,
}

parent.associate_faces(**kwargs)

1. See AssociateFacesRequestTypeDef

compare_faces

Compares a face in the source input image with each of the 100 largest faces detected in the target input image.

Type annotations and code completion for boto3.client("rekognition").compare_faces method. boto3 documentation

# compare_faces method definition

def compare_faces(
    self,
    *,
    SourceImage: ImageTypeDef,  # (1)
    TargetImage: ImageTypeDef,  # (1)
    SimilarityThreshold: float = ...,
    QualityFilter: QualityFilterType = ...,  # (3)
) -> CompareFacesResponseTypeDef:  # (4)
    ...

1. See ImageTypeDef
2. See ImageTypeDef
3. See QualityFilterType
4. See CompareFacesResponseTypeDef

# compare_faces method usage example with argument unpacking

kwargs: CompareFacesRequestTypeDef = {  # (1)
    "SourceImage": ...,
    "TargetImage": ...,
}

parent.compare_faces(**kwargs)

1. See CompareFacesRequestTypeDef

copy_project_version

This operation applies only to Amazon Rekognition Custom Labels.

Type annotations and code completion for boto3.client("rekognition").copy_project_version method. boto3 documentation

# copy_project_version method definition

def copy_project_version(
    self,
    *,
    SourceProjectArn: str,
    SourceProjectVersionArn: str,
    DestinationProjectArn: str,
    VersionName: str,
    OutputConfig: OutputConfigTypeDef,  # (1)
    Tags: Mapping[str, str] = ...,
    KmsKeyId: str = ...,
) -> CopyProjectVersionResponseTypeDef:  # (2)
    ...

1. See OutputConfigTypeDef
2. See CopyProjectVersionResponseTypeDef

# copy_project_version method usage example with argument unpacking

kwargs: CopyProjectVersionRequestTypeDef = {  # (1)
    "SourceProjectArn": ...,
    "SourceProjectVersionArn": ...,
    "DestinationProjectArn": ...,
    "VersionName": ...,
    "OutputConfig": ...,
}

parent.copy_project_version(**kwargs)

1. See CopyProjectVersionRequestTypeDef

create_collection

Creates a collection in an AWS Region.

Type annotations and code completion for boto3.client("rekognition").create_collection method. boto3 documentation

# create_collection method definition

def create_collection(
    self,
    *,
    CollectionId: str,
    Tags: Mapping[str, str] = ...,
) -> CreateCollectionResponseTypeDef:  # (1)
    ...

1. See CreateCollectionResponseTypeDef

# create_collection method usage example with argument unpacking

kwargs: CreateCollectionRequestTypeDef = {  # (1)
    "CollectionId": ...,
}

parent.create_collection(**kwargs)

1. See CreateCollectionRequestTypeDef

create_dataset

This operation applies only to Amazon Rekognition Custom Labels.

Type annotations and code completion for boto3.client("rekognition").create_dataset method. boto3 documentation

# create_dataset method definition

def create_dataset(
    self,
    *,
    DatasetType: DatasetTypeType,  # (1)
    ProjectArn: str,
    DatasetSource: DatasetSourceTypeDef = ...,  # (2)
    Tags: Mapping[str, str] = ...,
) -> CreateDatasetResponseTypeDef:  # (3)
    ...

1. See DatasetTypeType
2. See DatasetSourceTypeDef
3. See CreateDatasetResponseTypeDef

# create_dataset method usage example with argument unpacking

kwargs: CreateDatasetRequestTypeDef = {  # (1)
    "DatasetType": ...,
    "ProjectArn": ...,
}

parent.create_dataset(**kwargs)

1. See CreateDatasetRequestTypeDef

create_face_liveness_session

This API operation initiates a Face Liveness session.

Type annotations and code completion for boto3.client("rekognition").create_face_liveness_session method. boto3 documentation

# create_face_liveness_session method definition

def create_face_liveness_session(
    self,
    *,
    KmsKeyId: str = ...,
    Settings: CreateFaceLivenessSessionRequestSettingsTypeDef = ...,  # (1)
    ClientRequestToken: str = ...,
) -> CreateFaceLivenessSessionResponseTypeDef:  # (2)
    ...

1. See CreateFaceLivenessSessionRequestSettingsTypeDef
2. See CreateFaceLivenessSessionResponseTypeDef

# create_face_liveness_session method usage example with argument unpacking

kwargs: CreateFaceLivenessSessionRequestTypeDef = {  # (1)
    "KmsKeyId": ...,
}

parent.create_face_liveness_session(**kwargs)

1. See CreateFaceLivenessSessionRequestTypeDef

create_project

Creates a new Amazon Rekognition project.

Type annotations and code completion for boto3.client("rekognition").create_project method. boto3 documentation

# create_project method definition

def create_project(
    self,
    *,
    ProjectName: str,
    Feature: CustomizationFeatureType = ...,  # (1)
    AutoUpdate: ProjectAutoUpdateType = ...,  # (2)
    Tags: Mapping[str, str] = ...,
) -> CreateProjectResponseTypeDef:  # (3)
    ...

1. See CustomizationFeatureType
2. See ProjectAutoUpdateType
3. See CreateProjectResponseTypeDef

# create_project method usage example with argument unpacking

kwargs: CreateProjectRequestTypeDef = {  # (1)
    "ProjectName": ...,
}

parent.create_project(**kwargs)

1. See CreateProjectRequestTypeDef

create_project_version

Creates a new version of Amazon Rekognition project (like a Custom Labels model or a custom adapter) and begins training.

Type annotations and code completion for boto3.client("rekognition").create_project_version method. boto3 documentation

# create_project_version method definition

def create_project_version(
    self,
    *,
    ProjectArn: str,
    VersionName: str,
    OutputConfig: OutputConfigTypeDef,  # (1)
    TrainingData: TrainingDataUnionTypeDef = ...,  # (2)
    TestingData: TestingDataUnionTypeDef = ...,  # (3)
    Tags: Mapping[str, str] = ...,
    KmsKeyId: str = ...,
    VersionDescription: str = ...,
    FeatureConfig: CustomizationFeatureConfigTypeDef = ...,  # (4)
) -> CreateProjectVersionResponseTypeDef:  # (5)
    ...

1. See OutputConfigTypeDef
2. See TrainingDataUnionTypeDef
3. See TestingDataUnionTypeDef
4. See CustomizationFeatureConfigTypeDef
5. See CreateProjectVersionResponseTypeDef

# create_project_version method usage example with argument unpacking

kwargs: CreateProjectVersionRequestTypeDef = {  # (1)
    "ProjectArn": ...,
    "VersionName": ...,
    "OutputConfig": ...,
}

parent.create_project_version(**kwargs)

1. See CreateProjectVersionRequestTypeDef

create_stream_processor

Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces or to detect labels in a streaming video.

Type annotations and code completion for boto3.client("rekognition").create_stream_processor method. boto3 documentation

# create_stream_processor method definition

def create_stream_processor(
    self,
    *,
    Input: StreamProcessorInputTypeDef,  # (1)
    Output: StreamProcessorOutputTypeDef,  # (2)
    Name: str,
    Settings: StreamProcessorSettingsUnionTypeDef,  # (3)
    RoleArn: str,
    Tags: Mapping[str, str] = ...,
    NotificationChannel: StreamProcessorNotificationChannelTypeDef = ...,  # (4)
    KmsKeyId: str = ...,
    RegionsOfInterest: Sequence[RegionOfInterestUnionTypeDef] = ...,  # (5)
    DataSharingPreference: StreamProcessorDataSharingPreferenceTypeDef = ...,  # (6)
) -> CreateStreamProcessorResponseTypeDef:  # (7)
    ...

1. See StreamProcessorInputTypeDef
2. See StreamProcessorOutputTypeDef
3. See StreamProcessorSettingsUnionTypeDef
4. See StreamProcessorNotificationChannelTypeDef
5. See Sequence[RegionOfInterestUnionTypeDef]
6. See StreamProcessorDataSharingPreferenceTypeDef
7. See CreateStreamProcessorResponseTypeDef

# create_stream_processor method usage example with argument unpacking

kwargs: CreateStreamProcessorRequestTypeDef = {  # (1)
    "Input": ...,
    "Output": ...,
    "Name": ...,
    "Settings": ...,
    "RoleArn": ...,
}

parent.create_stream_processor(**kwargs)

1. See CreateStreamProcessorRequestTypeDef

create_user

Creates a new User within a collection specified by CollectionId.

Type annotations and code completion for boto3.client("rekognition").create_user method. boto3 documentation

# create_user method definition

def create_user(
    self,
    *,
    CollectionId: str,
    UserId: str,
    ClientRequestToken: str = ...,
) -> Dict[str, Any]:
    ...

# create_user method usage example with argument unpacking

kwargs: CreateUserRequestTypeDef = {  # (1)
    "CollectionId": ...,
    "UserId": ...,
}

parent.create_user(**kwargs)

1. See CreateUserRequestTypeDef

delete_collection

Deletes the specified collection.

Type annotations and code completion for boto3.client("rekognition").delete_collection method. boto3 documentation

# delete_collection method definition

def delete_collection(
    self,
    *,
    CollectionId: str,
) -> DeleteCollectionResponseTypeDef:  # (1)
    ...

1. See DeleteCollectionResponseTypeDef

# delete_collection method usage example with argument unpacking

kwargs: DeleteCollectionRequestTypeDef = {  # (1)
    "CollectionId": ...,
}

parent.delete_collection(**kwargs)

1. See DeleteCollectionRequestTypeDef

delete_dataset

This operation applies only to Amazon Rekognition Custom Labels.

Type annotations and code completion for boto3.client("rekognition").delete_dataset method. boto3 documentation

# delete_dataset method definition

def delete_dataset(
    self,
    *,
    DatasetArn: str,
) -> Dict[str, Any]:
    ...

# delete_dataset method usage example with argument unpacking

kwargs: DeleteDatasetRequestTypeDef = {  # (1)
    "DatasetArn": ...,
}

parent.delete_dataset(**kwargs)

1. See DeleteDatasetRequestTypeDef

delete_faces

Deletes faces from a collection.

Type annotations and code completion for boto3.client("rekognition").delete_faces method. boto3 documentation

# delete_faces method definition

def delete_faces(
    self,
    *,
    CollectionId: str,
    FaceIds: Sequence[str],
) -> DeleteFacesResponseTypeDef:  # (1)
    ...

1. See DeleteFacesResponseTypeDef

# delete_faces method usage example with argument unpacking

kwargs: DeleteFacesRequestTypeDef = {  # (1)
    "CollectionId": ...,
    "FaceIds": ...,
}

parent.delete_faces(**kwargs)

1. See DeleteFacesRequestTypeDef

delete_project

Deletes a Amazon Rekognition project.

Type annotations and code completion for boto3.client("rekognition").delete_project method. boto3 documentation

# delete_project method definition

def delete_project(
    self,
    *,
    ProjectArn: str,
) -> DeleteProjectResponseTypeDef:  # (1)
    ...

1. See DeleteProjectResponseTypeDef

# delete_project method usage example with argument unpacking

kwargs: DeleteProjectRequestTypeDef = {  # (1)
    "ProjectArn": ...,
}

parent.delete_project(**kwargs)

1. See DeleteProjectRequestTypeDef

delete_project_policy

This operation applies only to Amazon Rekognition Custom Labels.

Type annotations and code completion for boto3.client("rekognition").delete_project_policy method. boto3 documentation

# delete_project_policy method definition

def delete_project_policy(
    self,
    *,
    ProjectArn: str,
    PolicyName: str,
    PolicyRevisionId: str = ...,
) -> Dict[str, Any]:
    ...

# delete_project_policy method usage example with argument unpacking

kwargs: DeleteProjectPolicyRequestTypeDef = {  # (1)
    "ProjectArn": ...,
    "PolicyName": ...,
}

parent.delete_project_policy(**kwargs)

1. See DeleteProjectPolicyRequestTypeDef

delete_project_version

Deletes a Rekognition project model or project version, like a Amazon Rekognition Custom Labels model or a custom adapter.

Type annotations and code completion for boto3.client("rekognition").delete_project_version method. boto3 documentation

# delete_project_version method definition

def delete_project_version(
    self,
    *,
    ProjectVersionArn: str,
) -> DeleteProjectVersionResponseTypeDef:  # (1)
    ...

1. See DeleteProjectVersionResponseTypeDef

# delete_project_version method usage example with argument unpacking

kwargs: DeleteProjectVersionRequestTypeDef = {  # (1)
    "ProjectVersionArn": ...,
}

parent.delete_project_version(**kwargs)

1. See DeleteProjectVersionRequestTypeDef

delete_stream_processor

Deletes the stream processor identified by Name.

Type annotations and code completion for boto3.client("rekognition").delete_stream_processor method. boto3 documentation

# delete_stream_processor method definition

def delete_stream_processor(
    self,
    *,
    Name: str,
) -> Dict[str, Any]:
    ...

# delete_stream_processor method usage example with argument unpacking

kwargs: DeleteStreamProcessorRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.delete_stream_processor(**kwargs)

1. See DeleteStreamProcessorRequestTypeDef

delete_user

Deletes the specified UserID within the collection.

Type annotations and code completion for boto3.client("rekognition").delete_user method. boto3 documentation

# delete_user method definition

def delete_user(
    self,
    *,
    CollectionId: str,
    UserId: str,
    ClientRequestToken: str = ...,
) -> Dict[str, Any]:
    ...

# delete_user method usage example with argument unpacking

kwargs: DeleteUserRequestTypeDef = {  # (1)
    "CollectionId": ...,
    "UserId": ...,
}

parent.delete_user(**kwargs)

1. See DeleteUserRequestTypeDef

describe_collection

Describes the specified collection.

Type annotations and code completion for boto3.client("rekognition").describe_collection method. boto3 documentation

# describe_collection method definition

def describe_collection(
    self,
    *,
    CollectionId: str,
) -> DescribeCollectionResponseTypeDef:  # (1)
    ...

1. See DescribeCollectionResponseTypeDef

# describe_collection method usage example with argument unpacking

kwargs: DescribeCollectionRequestTypeDef = {  # (1)
    "CollectionId": ...,
}

parent.describe_collection(**kwargs)

1. See DescribeCollectionRequestTypeDef

describe_dataset

This operation applies only to Amazon Rekognition Custom Labels.

Type annotations and code completion for boto3.client("rekognition").describe_dataset method. boto3 documentation

# describe_dataset method definition

def describe_dataset(
    self,
    *,
    DatasetArn: str,
) -> DescribeDatasetResponseTypeDef:  # (1)
    ...

1. See DescribeDatasetResponseTypeDef

# describe_dataset method usage example with argument unpacking

kwargs: DescribeDatasetRequestTypeDef = {  # (1)
    "DatasetArn": ...,
}

parent.describe_dataset(**kwargs)

1. See DescribeDatasetRequestTypeDef

describe_project_versions

Lists and describes the versions of an Amazon Rekognition project.

Type annotations and code completion for boto3.client("rekognition").describe_project_versions method. boto3 documentation

# describe_project_versions method definition

def describe_project_versions(
    self,
    *,
    ProjectArn: str,
    VersionNames: Sequence[str] = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> DescribeProjectVersionsResponseTypeDef:  # (1)
    ...

1. See DescribeProjectVersionsResponseTypeDef

# describe_project_versions method usage example with argument unpacking

kwargs: DescribeProjectVersionsRequestTypeDef = {  # (1)
    "ProjectArn": ...,
}

parent.describe_project_versions(**kwargs)

1. See DescribeProjectVersionsRequestTypeDef

describe_projects

Gets information about your Rekognition projects.

Type annotations and code completion for boto3.client("rekognition").describe_projects method. boto3 documentation

# describe_projects method definition

def describe_projects(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
    ProjectNames: Sequence[str] = ...,
    Features: Sequence[CustomizationFeatureType] = ...,  # (1)
) -> DescribeProjectsResponseTypeDef:  # (2)
    ...

1. See Sequence[CustomizationFeatureType]
2. See DescribeProjectsResponseTypeDef

# describe_projects method usage example with argument unpacking

kwargs: DescribeProjectsRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.describe_projects(**kwargs)

1. See DescribeProjectsRequestTypeDef

describe_stream_processor

Provides information about a stream processor created by CreateStreamProcessor.

Type annotations and code completion for boto3.client("rekognition").describe_stream_processor method. boto3 documentation

# describe_stream_processor method definition

def describe_stream_processor(
    self,
    *,
    Name: str,
) -> DescribeStreamProcessorResponseTypeDef:  # (1)
    ...

1. See DescribeStreamProcessorResponseTypeDef

# describe_stream_processor method usage example with argument unpacking

kwargs: DescribeStreamProcessorRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.describe_stream_processor(**kwargs)

1. See DescribeStreamProcessorRequestTypeDef

detect_custom_labels

This operation applies only to Amazon Rekognition Custom Labels.

Type annotations and code completion for boto3.client("rekognition").detect_custom_labels method. boto3 documentation

# detect_custom_labels method definition

def detect_custom_labels(
    self,
    *,
    ProjectVersionArn: str,
    Image: ImageTypeDef,  # (1)
    MaxResults: int = ...,
    MinConfidence: float = ...,
) -> DetectCustomLabelsResponseTypeDef:  # (2)
    ...

1. See ImageTypeDef
2. See DetectCustomLabelsResponseTypeDef

# detect_custom_labels method usage example with argument unpacking

kwargs: DetectCustomLabelsRequestTypeDef = {  # (1)
    "ProjectVersionArn": ...,
    "Image": ...,
}

parent.detect_custom_labels(**kwargs)

1. See DetectCustomLabelsRequestTypeDef

detect_faces

Detects faces within an image that is provided as input.

Type annotations and code completion for boto3.client("rekognition").detect_faces method. boto3 documentation

# detect_faces method definition

def detect_faces(
    self,
    *,
    Image: ImageTypeDef,  # (1)
    Attributes: Sequence[AttributeType] = ...,  # (2)
) -> DetectFacesResponseTypeDef:  # (3)
    ...

1. See ImageTypeDef
2. See Sequence[AttributeType]
3. See DetectFacesResponseTypeDef

# detect_faces method usage example with argument unpacking

kwargs: DetectFacesRequestTypeDef = {  # (1)
    "Image": ...,
}

parent.detect_faces(**kwargs)

1. See DetectFacesRequestTypeDef

detect_labels

Detects instances of real-world entities within an image (JPEG or PNG) provided as input.

Type annotations and code completion for boto3.client("rekognition").detect_labels method. boto3 documentation

# detect_labels method definition

def detect_labels(
    self,
    *,
    Image: ImageTypeDef,  # (1)
    MaxLabels: int = ...,
    MinConfidence: float = ...,
    Features: Sequence[DetectLabelsFeatureNameType] = ...,  # (2)
    Settings: DetectLabelsSettingsTypeDef = ...,  # (3)
) -> DetectLabelsResponseTypeDef:  # (4)
    ...

1. See ImageTypeDef
2. See Sequence[DetectLabelsFeatureNameType]
3. See DetectLabelsSettingsTypeDef
4. See DetectLabelsResponseTypeDef

# detect_labels method usage example with argument unpacking

kwargs: DetectLabelsRequestTypeDef = {  # (1)
    "Image": ...,
}

parent.detect_labels(**kwargs)

1. See DetectLabelsRequestTypeDef

detect_moderation_labels

Detects unsafe content in a specified JPEG or PNG format image.

Type annotations and code completion for boto3.client("rekognition").detect_moderation_labels method. boto3 documentation

# detect_moderation_labels method definition

def detect_moderation_labels(
    self,
    *,
    Image: ImageTypeDef,  # (1)
    MinConfidence: float = ...,
    HumanLoopConfig: HumanLoopConfigTypeDef = ...,  # (2)
    ProjectVersion: str = ...,
) -> DetectModerationLabelsResponseTypeDef:  # (3)
    ...

1. See ImageTypeDef
2. See HumanLoopConfigTypeDef
3. See DetectModerationLabelsResponseTypeDef

# detect_moderation_labels method usage example with argument unpacking

kwargs: DetectModerationLabelsRequestTypeDef = {  # (1)
    "Image": ...,
}

parent.detect_moderation_labels(**kwargs)

1. See DetectModerationLabelsRequestTypeDef

detect_protective_equipment

Detects Personal Protective Equipment (PPE) worn by people detected in an image.

Type annotations and code completion for boto3.client("rekognition").detect_protective_equipment method. boto3 documentation

# detect_protective_equipment method definition

def detect_protective_equipment(
    self,
    *,
    Image: ImageTypeDef,  # (1)
    SummarizationAttributes: ProtectiveEquipmentSummarizationAttributesTypeDef = ...,  # (2)
) -> DetectProtectiveEquipmentResponseTypeDef:  # (3)
    ...

1. See ImageTypeDef
2. See ProtectiveEquipmentSummarizationAttributesTypeDef
3. See DetectProtectiveEquipmentResponseTypeDef

# detect_protective_equipment method usage example with argument unpacking

kwargs: DetectProtectiveEquipmentRequestTypeDef = {  # (1)
    "Image": ...,
}

parent.detect_protective_equipment(**kwargs)

1. See DetectProtectiveEquipmentRequestTypeDef

detect_text

Detects text in the input image and converts it into machine-readable text.

Type annotations and code completion for boto3.client("rekognition").detect_text method. boto3 documentation

# detect_text method definition

def detect_text(
    self,
    *,
    Image: ImageTypeDef,  # (1)
    Filters: DetectTextFiltersTypeDef = ...,  # (2)
) -> DetectTextResponseTypeDef:  # (3)
    ...

1. See ImageTypeDef
2. See DetectTextFiltersTypeDef
3. See DetectTextResponseTypeDef

# detect_text method usage example with argument unpacking

kwargs: DetectTextRequestTypeDef = {  # (1)
    "Image": ...,
}

parent.detect_text(**kwargs)

1. See DetectTextRequestTypeDef

disassociate_faces

Removes the association between a Face supplied in an array of FaceIds and the User.

Type annotations and code completion for boto3.client("rekognition").disassociate_faces method. boto3 documentation

# disassociate_faces method definition

def disassociate_faces(
    self,
    *,
    CollectionId: str,
    UserId: str,
    FaceIds: Sequence[str],
    ClientRequestToken: str = ...,
) -> DisassociateFacesResponseTypeDef:  # (1)
    ...

1. See DisassociateFacesResponseTypeDef

# disassociate_faces method usage example with argument unpacking

kwargs: DisassociateFacesRequestTypeDef = {  # (1)
    "CollectionId": ...,
    "UserId": ...,
    "FaceIds": ...,
}

parent.disassociate_faces(**kwargs)

1. See DisassociateFacesRequestTypeDef

distribute_dataset_entries

This operation applies only to Amazon Rekognition Custom Labels.

Type annotations and code completion for boto3.client("rekognition").distribute_dataset_entries method. boto3 documentation

# distribute_dataset_entries method definition

def distribute_dataset_entries(
    self,
    *,
    Datasets: Sequence[DistributeDatasetTypeDef],  # (1)
) -> Dict[str, Any]:
    ...

1. See Sequence[DistributeDatasetTypeDef]

# distribute_dataset_entries method usage example with argument unpacking

kwargs: DistributeDatasetEntriesRequestTypeDef = {  # (1)
    "Datasets": ...,
}

parent.distribute_dataset_entries(**kwargs)

1. See DistributeDatasetEntriesRequestTypeDef

get_celebrity_info

Gets the name and additional information about a celebrity based on their Amazon Rekognition ID.

Type annotations and code completion for boto3.client("rekognition").get_celebrity_info method. boto3 documentation

# get_celebrity_info method definition

def get_celebrity_info(
    self,
    *,
    Id: str,
) -> GetCelebrityInfoResponseTypeDef:  # (1)
    ...

1. See GetCelebrityInfoResponseTypeDef

# get_celebrity_info method usage example with argument unpacking

kwargs: GetCelebrityInfoRequestTypeDef = {  # (1)
    "Id": ...,
}

parent.get_celebrity_info(**kwargs)

1. See GetCelebrityInfoRequestTypeDef

get_celebrity_recognition

Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by StartCelebrityRecognition.

Type annotations and code completion for boto3.client("rekognition").get_celebrity_recognition method. boto3 documentation

# get_celebrity_recognition method definition

def get_celebrity_recognition(
    self,
    *,
    JobId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    SortBy: CelebrityRecognitionSortByType = ...,  # (1)
) -> GetCelebrityRecognitionResponseTypeDef:  # (2)
    ...

1. See CelebrityRecognitionSortByType
2. See GetCelebrityRecognitionResponseTypeDef

# get_celebrity_recognition method usage example with argument unpacking

kwargs: GetCelebrityRecognitionRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.get_celebrity_recognition(**kwargs)

1. See GetCelebrityRecognitionRequestTypeDef

get_content_moderation

Gets the inappropriate, unwanted, or offensive content analysis results for a Amazon Rekognition Video analysis started by StartContentModeration.

Type annotations and code completion for boto3.client("rekognition").get_content_moderation method. boto3 documentation

# get_content_moderation method definition

def get_content_moderation(
    self,
    *,
    JobId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    SortBy: ContentModerationSortByType = ...,  # (1)
    AggregateBy: ContentModerationAggregateByType = ...,  # (2)
) -> GetContentModerationResponseTypeDef:  # (3)
    ...

1. See ContentModerationSortByType
2. See ContentModerationAggregateByType
3. See GetContentModerationResponseTypeDef

# get_content_moderation method usage example with argument unpacking

kwargs: GetContentModerationRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.get_content_moderation(**kwargs)

1. See GetContentModerationRequestTypeDef

get_face_detection

Gets face detection results for a Amazon Rekognition Video analysis started by StartFaceDetection.

Type annotations and code completion for boto3.client("rekognition").get_face_detection method. boto3 documentation

# get_face_detection method definition

def get_face_detection(
    self,
    *,
    JobId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetFaceDetectionResponseTypeDef:  # (1)
    ...

1. See GetFaceDetectionResponseTypeDef

# get_face_detection method usage example with argument unpacking

kwargs: GetFaceDetectionRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.get_face_detection(**kwargs)

1. See GetFaceDetectionRequestTypeDef

get_face_liveness_session_results

Retrieves the results of a specific Face Liveness session.

Type annotations and code completion for boto3.client("rekognition").get_face_liveness_session_results method. boto3 documentation

# get_face_liveness_session_results method definition

def get_face_liveness_session_results(
    self,
    *,
    SessionId: str,
) -> GetFaceLivenessSessionResultsResponseTypeDef:  # (1)
    ...

1. See GetFaceLivenessSessionResultsResponseTypeDef

# get_face_liveness_session_results method usage example with argument unpacking

kwargs: GetFaceLivenessSessionResultsRequestTypeDef = {  # (1)
    "SessionId": ...,
}

parent.get_face_liveness_session_results(**kwargs)

1. See GetFaceLivenessSessionResultsRequestTypeDef

get_face_search

Gets the face search results for Amazon Rekognition Video face search started by StartFaceSearch.

Type annotations and code completion for boto3.client("rekognition").get_face_search method. boto3 documentation

# get_face_search method definition

def get_face_search(
    self,
    *,
    JobId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    SortBy: FaceSearchSortByType = ...,  # (1)
) -> GetFaceSearchResponseTypeDef:  # (2)
    ...

1. See FaceSearchSortByType
2. See GetFaceSearchResponseTypeDef

# get_face_search method usage example with argument unpacking

kwargs: GetFaceSearchRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.get_face_search(**kwargs)

1. See GetFaceSearchRequestTypeDef

get_label_detection

Gets the label detection results of a Amazon Rekognition Video analysis started by StartLabelDetection.

Type annotations and code completion for boto3.client("rekognition").get_label_detection method. boto3 documentation

# get_label_detection method definition

def get_label_detection(
    self,
    *,
    JobId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    SortBy: LabelDetectionSortByType = ...,  # (1)
    AggregateBy: LabelDetectionAggregateByType = ...,  # (2)
) -> GetLabelDetectionResponseTypeDef:  # (3)
    ...

1. See LabelDetectionSortByType
2. See LabelDetectionAggregateByType
3. See GetLabelDetectionResponseTypeDef

# get_label_detection method usage example with argument unpacking

kwargs: GetLabelDetectionRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.get_label_detection(**kwargs)

1. See GetLabelDetectionRequestTypeDef

get_media_analysis_job

Retrieves the results for a given media analysis job.

Type annotations and code completion for boto3.client("rekognition").get_media_analysis_job method. boto3 documentation

# get_media_analysis_job method definition

def get_media_analysis_job(
    self,
    *,
    JobId: str,
) -> GetMediaAnalysisJobResponseTypeDef:  # (1)
    ...

1. See GetMediaAnalysisJobResponseTypeDef

# get_media_analysis_job method usage example with argument unpacking

kwargs: GetMediaAnalysisJobRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.get_media_analysis_job(**kwargs)

1. See GetMediaAnalysisJobRequestTypeDef

get_person_tracking

Gets the path tracking results of a Amazon Rekognition Video analysis started by StartPersonTracking.

Type annotations and code completion for boto3.client("rekognition").get_person_tracking method. boto3 documentation

# get_person_tracking method definition

def get_person_tracking(
    self,
    *,
    JobId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
    SortBy: PersonTrackingSortByType = ...,  # (1)
) -> GetPersonTrackingResponseTypeDef:  # (2)
    ...

1. See PersonTrackingSortByType
2. See GetPersonTrackingResponseTypeDef

# get_person_tracking method usage example with argument unpacking

kwargs: GetPersonTrackingRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.get_person_tracking(**kwargs)

1. See GetPersonTrackingRequestTypeDef

get_segment_detection

Gets the segment detection results of a Amazon Rekognition Video analysis started by StartSegmentDetection.

Type annotations and code completion for boto3.client("rekognition").get_segment_detection method. boto3 documentation

# get_segment_detection method definition

def get_segment_detection(
    self,
    *,
    JobId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetSegmentDetectionResponseTypeDef:  # (1)
    ...

1. See GetSegmentDetectionResponseTypeDef

# get_segment_detection method usage example with argument unpacking

kwargs: GetSegmentDetectionRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.get_segment_detection(**kwargs)

1. See GetSegmentDetectionRequestTypeDef

get_text_detection

Gets the text detection results of a Amazon Rekognition Video analysis started by StartTextDetection.

Type annotations and code completion for boto3.client("rekognition").get_text_detection method. boto3 documentation

# get_text_detection method definition

def get_text_detection(
    self,
    *,
    JobId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> GetTextDetectionResponseTypeDef:  # (1)
    ...

1. See GetTextDetectionResponseTypeDef

# get_text_detection method usage example with argument unpacking

kwargs: GetTextDetectionRequestTypeDef = {  # (1)
    "JobId": ...,
}

parent.get_text_detection(**kwargs)

1. See GetTextDetectionRequestTypeDef

index_faces

Detects faces in the input image and adds them to the specified collection.

Type annotations and code completion for boto3.client("rekognition").index_faces method. boto3 documentation

# index_faces method definition

def index_faces(
    self,
    *,
    CollectionId: str,
    Image: ImageTypeDef,  # (1)
    ExternalImageId: str = ...,
    DetectionAttributes: Sequence[AttributeType] = ...,  # (2)
    MaxFaces: int = ...,
    QualityFilter: QualityFilterType = ...,  # (3)
) -> IndexFacesResponseTypeDef:  # (4)
    ...

1. See ImageTypeDef
2. See Sequence[AttributeType]
3. See QualityFilterType
4. See IndexFacesResponseTypeDef

# index_faces method usage example with argument unpacking

kwargs: IndexFacesRequestTypeDef = {  # (1)
    "CollectionId": ...,
    "Image": ...,
}

parent.index_faces(**kwargs)

1. See IndexFacesRequestTypeDef

list_collections

Returns list of collection IDs in your account.

Type annotations and code completion for boto3.client("rekognition").list_collections method. boto3 documentation

# list_collections method definition

def list_collections(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListCollectionsResponseTypeDef:  # (1)
    ...

1. See ListCollectionsResponseTypeDef

# list_collections method usage example with argument unpacking

kwargs: ListCollectionsRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_collections(**kwargs)

1. See ListCollectionsRequestTypeDef

list_dataset_entries

This operation applies only to Amazon Rekognition Custom Labels.

Type annotations and code completion for boto3.client("rekognition").list_dataset_entries method. boto3 documentation

# list_dataset_entries method definition

def list_dataset_entries(
    self,
    *,
    DatasetArn: str,
    ContainsLabels: Sequence[str] = ...,
    Labeled: bool = ...,
    SourceRefContains: str = ...,
    HasErrors: bool = ...,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDatasetEntriesResponseTypeDef:  # (1)
    ...

1. See ListDatasetEntriesResponseTypeDef

# list_dataset_entries method usage example with argument unpacking

kwargs: ListDatasetEntriesRequestTypeDef = {  # (1)
    "DatasetArn": ...,
}

parent.list_dataset_entries(**kwargs)

1. See ListDatasetEntriesRequestTypeDef

list_dataset_labels

This operation applies only to Amazon Rekognition Custom Labels.

Type annotations and code completion for boto3.client("rekognition").list_dataset_labels method. boto3 documentation

# list_dataset_labels method definition

def list_dataset_labels(
    self,
    *,
    DatasetArn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListDatasetLabelsResponseTypeDef:  # (1)
    ...

1. See ListDatasetLabelsResponseTypeDef

# list_dataset_labels method usage example with argument unpacking

kwargs: ListDatasetLabelsRequestTypeDef = {  # (1)
    "DatasetArn": ...,
}

parent.list_dataset_labels(**kwargs)

1. See ListDatasetLabelsRequestTypeDef

list_faces

Returns metadata for faces in the specified collection.

Type annotations and code completion for boto3.client("rekognition").list_faces method. boto3 documentation

# list_faces method definition

def list_faces(
    self,
    *,
    CollectionId: str,
    NextToken: str = ...,
    MaxResults: int = ...,
    UserId: str = ...,
    FaceIds: Sequence[str] = ...,
) -> ListFacesResponseTypeDef:  # (1)
    ...

1. See ListFacesResponseTypeDef

# list_faces method usage example with argument unpacking

kwargs: ListFacesRequestTypeDef = {  # (1)
    "CollectionId": ...,
}

parent.list_faces(**kwargs)

1. See ListFacesRequestTypeDef

list_media_analysis_jobs

Returns a list of media analysis jobs.

Type annotations and code completion for boto3.client("rekognition").list_media_analysis_jobs method. boto3 documentation

# list_media_analysis_jobs method definition

def list_media_analysis_jobs(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListMediaAnalysisJobsResponseTypeDef:  # (1)
    ...

1. See ListMediaAnalysisJobsResponseTypeDef

# list_media_analysis_jobs method usage example with argument unpacking

kwargs: ListMediaAnalysisJobsRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_media_analysis_jobs(**kwargs)

1. See ListMediaAnalysisJobsRequestTypeDef

list_project_policies

This operation applies only to Amazon Rekognition Custom Labels.

Type annotations and code completion for boto3.client("rekognition").list_project_policies method. boto3 documentation

# list_project_policies method definition

def list_project_policies(
    self,
    *,
    ProjectArn: str,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListProjectPoliciesResponseTypeDef:  # (1)
    ...

1. See ListProjectPoliciesResponseTypeDef

# list_project_policies method usage example with argument unpacking

kwargs: ListProjectPoliciesRequestTypeDef = {  # (1)
    "ProjectArn": ...,
}

parent.list_project_policies(**kwargs)

1. See ListProjectPoliciesRequestTypeDef

list_stream_processors

Gets a list of stream processors that you have created with CreateStreamProcessor.

Type annotations and code completion for boto3.client("rekognition").list_stream_processors method. boto3 documentation

# list_stream_processors method definition

def list_stream_processors(
    self,
    *,
    NextToken: str = ...,
    MaxResults: int = ...,
) -> ListStreamProcessorsResponseTypeDef:  # (1)
    ...

1. See ListStreamProcessorsResponseTypeDef

# list_stream_processors method usage example with argument unpacking

kwargs: ListStreamProcessorsRequestTypeDef = {  # (1)
    "NextToken": ...,
}

parent.list_stream_processors(**kwargs)

1. See ListStreamProcessorsRequestTypeDef

list_tags_for_resource

Returns a list of tags in an Amazon Rekognition collection, stream processor, or Custom Labels model.

Type annotations and code completion for boto3.client("rekognition").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    ResourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestTypeDef

list_users

Returns metadata of the User such as UserID in the specified collection.

Type annotations and code completion for boto3.client("rekognition").list_users method. boto3 documentation

# list_users method definition

def list_users(
    self,
    *,
    CollectionId: str,
    MaxResults: int = ...,
    NextToken: str = ...,
) -> ListUsersResponseTypeDef:  # (1)
    ...

1. See ListUsersResponseTypeDef

# list_users method usage example with argument unpacking

kwargs: ListUsersRequestTypeDef = {  # (1)
    "CollectionId": ...,
}

parent.list_users(**kwargs)

1. See ListUsersRequestTypeDef

put_project_policy

This operation applies only to Amazon Rekognition Custom Labels.

Type annotations and code completion for boto3.client("rekognition").put_project_policy method. boto3 documentation

# put_project_policy method definition

def put_project_policy(
    self,
    *,
    ProjectArn: str,
    PolicyName: str,
    PolicyDocument: str,
    PolicyRevisionId: str = ...,
) -> PutProjectPolicyResponseTypeDef:  # (1)
    ...

1. See PutProjectPolicyResponseTypeDef

# put_project_policy method usage example with argument unpacking

kwargs: PutProjectPolicyRequestTypeDef = {  # (1)
    "ProjectArn": ...,
    "PolicyName": ...,
    "PolicyDocument": ...,
}

parent.put_project_policy(**kwargs)

1. See PutProjectPolicyRequestTypeDef

recognize_celebrities

Returns an array of celebrities recognized in the input image.

Type annotations and code completion for boto3.client("rekognition").recognize_celebrities method. boto3 documentation

# recognize_celebrities method definition

def recognize_celebrities(
    self,
    *,
    Image: ImageTypeDef,  # (1)
) -> RecognizeCelebritiesResponseTypeDef:  # (2)
    ...

1. See ImageTypeDef
2. See RecognizeCelebritiesResponseTypeDef

# recognize_celebrities method usage example with argument unpacking

kwargs: RecognizeCelebritiesRequestTypeDef = {  # (1)
    "Image": ...,
}

parent.recognize_celebrities(**kwargs)

1. See RecognizeCelebritiesRequestTypeDef

search_faces

For a given input face ID, searches for matching faces in the collection the face belongs to.

Type annotations and code completion for boto3.client("rekognition").search_faces method. boto3 documentation

# search_faces method definition

def search_faces(
    self,
    *,
    CollectionId: str,
    FaceId: str,
    MaxFaces: int = ...,
    FaceMatchThreshold: float = ...,
) -> SearchFacesResponseTypeDef:  # (1)
    ...

1. See SearchFacesResponseTypeDef

# search_faces method usage example with argument unpacking

kwargs: SearchFacesRequestTypeDef = {  # (1)
    "CollectionId": ...,
    "FaceId": ...,
}

parent.search_faces(**kwargs)

1. See SearchFacesRequestTypeDef

search_faces_by_image

For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces.

Type annotations and code completion for boto3.client("rekognition").search_faces_by_image method. boto3 documentation

# search_faces_by_image method definition

def search_faces_by_image(
    self,
    *,
    CollectionId: str,
    Image: ImageTypeDef,  # (1)
    MaxFaces: int = ...,
    FaceMatchThreshold: float = ...,
    QualityFilter: QualityFilterType = ...,  # (2)
) -> SearchFacesByImageResponseTypeDef:  # (3)
    ...

1. See ImageTypeDef
2. See QualityFilterType
3. See SearchFacesByImageResponseTypeDef

# search_faces_by_image method usage example with argument unpacking

kwargs: SearchFacesByImageRequestTypeDef = {  # (1)
    "CollectionId": ...,
    "Image": ...,
}

parent.search_faces_by_image(**kwargs)

1. See SearchFacesByImageRequestTypeDef

search_users

Searches for UserIDs within a collection based on a FaceId or UserId.

Type annotations and code completion for boto3.client("rekognition").search_users method. boto3 documentation

# search_users method definition

def search_users(
    self,
    *,
    CollectionId: str,
    UserId: str = ...,
    FaceId: str = ...,
    UserMatchThreshold: float = ...,
    MaxUsers: int = ...,
) -> SearchUsersResponseTypeDef:  # (1)
    ...

1. See SearchUsersResponseTypeDef

# search_users method usage example with argument unpacking

kwargs: SearchUsersRequestTypeDef = {  # (1)
    "CollectionId": ...,
}

parent.search_users(**kwargs)

1. See SearchUsersRequestTypeDef

search_users_by_image

Searches for UserIDs using a supplied image.

Type annotations and code completion for boto3.client("rekognition").search_users_by_image method. boto3 documentation

# search_users_by_image method definition

def search_users_by_image(
    self,
    *,
    CollectionId: str,
    Image: ImageTypeDef,  # (1)
    UserMatchThreshold: float = ...,
    MaxUsers: int = ...,
    QualityFilter: QualityFilterType = ...,  # (2)
) -> SearchUsersByImageResponseTypeDef:  # (3)
    ...

1. See ImageTypeDef
2. See QualityFilterType
3. See SearchUsersByImageResponseTypeDef

# search_users_by_image method usage example with argument unpacking

kwargs: SearchUsersByImageRequestTypeDef = {  # (1)
    "CollectionId": ...,
    "Image": ...,
}

parent.search_users_by_image(**kwargs)

1. See SearchUsersByImageRequestTypeDef

start_celebrity_recognition

Starts asynchronous recognition of celebrities in a stored video.

Type annotations and code completion for boto3.client("rekognition").start_celebrity_recognition method. boto3 documentation

# start_celebrity_recognition method definition

def start_celebrity_recognition(
    self,
    *,
    Video: VideoTypeDef,  # (1)
    ClientRequestToken: str = ...,
    NotificationChannel: NotificationChannelTypeDef = ...,  # (2)
    JobTag: str = ...,
) -> StartCelebrityRecognitionResponseTypeDef:  # (3)
    ...

1. See VideoTypeDef
2. See NotificationChannelTypeDef
3. See StartCelebrityRecognitionResponseTypeDef

# start_celebrity_recognition method usage example with argument unpacking

kwargs: StartCelebrityRecognitionRequestTypeDef = {  # (1)
    "Video": ...,
}

parent.start_celebrity_recognition(**kwargs)

1. See StartCelebrityRecognitionRequestTypeDef

start_content_moderation

Starts asynchronous detection of inappropriate, unwanted, or offensive content in a stored video.

Type annotations and code completion for boto3.client("rekognition").start_content_moderation method. boto3 documentation

# start_content_moderation method definition

def start_content_moderation(
    self,
    *,
    Video: VideoTypeDef,  # (1)
    MinConfidence: float = ...,
    ClientRequestToken: str = ...,
    NotificationChannel: NotificationChannelTypeDef = ...,  # (2)
    JobTag: str = ...,
) -> StartContentModerationResponseTypeDef:  # (3)
    ...

1. See VideoTypeDef
2. See NotificationChannelTypeDef
3. See StartContentModerationResponseTypeDef

# start_content_moderation method usage example with argument unpacking

kwargs: StartContentModerationRequestTypeDef = {  # (1)
    "Video": ...,
}

parent.start_content_moderation(**kwargs)

1. See StartContentModerationRequestTypeDef

start_face_detection

Starts asynchronous detection of faces in a stored video.

Type annotations and code completion for boto3.client("rekognition").start_face_detection method. boto3 documentation

# start_face_detection method definition

def start_face_detection(
    self,
    *,
    Video: VideoTypeDef,  # (1)
    ClientRequestToken: str = ...,
    NotificationChannel: NotificationChannelTypeDef = ...,  # (2)
    FaceAttributes: FaceAttributesType = ...,  # (3)
    JobTag: str = ...,
) -> StartFaceDetectionResponseTypeDef:  # (4)
    ...

1. See VideoTypeDef
2. See NotificationChannelTypeDef
3. See FaceAttributesType
4. See StartFaceDetectionResponseTypeDef

# start_face_detection method usage example with argument unpacking

kwargs: StartFaceDetectionRequestTypeDef = {  # (1)
    "Video": ...,
}

parent.start_face_detection(**kwargs)

1. See StartFaceDetectionRequestTypeDef

start_face_search

Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video.

Type annotations and code completion for boto3.client("rekognition").start_face_search method. boto3 documentation

# start_face_search method definition

def start_face_search(
    self,
    *,
    Video: VideoTypeDef,  # (1)
    CollectionId: str,
    ClientRequestToken: str = ...,
    FaceMatchThreshold: float = ...,
    NotificationChannel: NotificationChannelTypeDef = ...,  # (2)
    JobTag: str = ...,
) -> StartFaceSearchResponseTypeDef:  # (3)
    ...

1. See VideoTypeDef
2. See NotificationChannelTypeDef
3. See StartFaceSearchResponseTypeDef

# start_face_search method usage example with argument unpacking

kwargs: StartFaceSearchRequestTypeDef = {  # (1)
    "Video": ...,
    "CollectionId": ...,
}

parent.start_face_search(**kwargs)

1. See StartFaceSearchRequestTypeDef

start_label_detection

Starts asynchronous detection of labels in a stored video.

Type annotations and code completion for boto3.client("rekognition").start_label_detection method. boto3 documentation

# start_label_detection method definition

def start_label_detection(
    self,
    *,
    Video: VideoTypeDef,  # (1)
    ClientRequestToken: str = ...,
    MinConfidence: float = ...,
    NotificationChannel: NotificationChannelTypeDef = ...,  # (2)
    JobTag: str = ...,
    Features: Sequence[LabelDetectionFeatureNameType] = ...,  # (3)
    Settings: LabelDetectionSettingsTypeDef = ...,  # (4)
) -> StartLabelDetectionResponseTypeDef:  # (5)
    ...

1. See VideoTypeDef
2. See NotificationChannelTypeDef
3. See Sequence[Literal['GENERAL_LABELS']]
4. See LabelDetectionSettingsTypeDef
5. See StartLabelDetectionResponseTypeDef

# start_label_detection method usage example with argument unpacking

kwargs: StartLabelDetectionRequestTypeDef = {  # (1)
    "Video": ...,
}

parent.start_label_detection(**kwargs)

1. See StartLabelDetectionRequestTypeDef

start_media_analysis_job

Initiates a new media analysis job.

Type annotations and code completion for boto3.client("rekognition").start_media_analysis_job method. boto3 documentation

# start_media_analysis_job method definition

def start_media_analysis_job(
    self,
    *,
    OperationsConfig: MediaAnalysisOperationsConfigTypeDef,  # (1)
    Input: MediaAnalysisInputTypeDef,  # (2)
    OutputConfig: MediaAnalysisOutputConfigTypeDef,  # (3)
    ClientRequestToken: str = ...,
    JobName: str = ...,
    KmsKeyId: str = ...,
) -> StartMediaAnalysisJobResponseTypeDef:  # (4)
    ...

1. See MediaAnalysisOperationsConfigTypeDef
2. See MediaAnalysisInputTypeDef
3. See MediaAnalysisOutputConfigTypeDef
4. See StartMediaAnalysisJobResponseTypeDef

# start_media_analysis_job method usage example with argument unpacking

kwargs: StartMediaAnalysisJobRequestTypeDef = {  # (1)
    "OperationsConfig": ...,
    "Input": ...,
    "OutputConfig": ...,
}

parent.start_media_analysis_job(**kwargs)

1. See StartMediaAnalysisJobRequestTypeDef

start_person_tracking

Starts the asynchronous tracking of a person's path in a stored video.

Type annotations and code completion for boto3.client("rekognition").start_person_tracking method. boto3 documentation

# start_person_tracking method definition

def start_person_tracking(
    self,
    *,
    Video: VideoTypeDef,  # (1)
    ClientRequestToken: str = ...,
    NotificationChannel: NotificationChannelTypeDef = ...,  # (2)
    JobTag: str = ...,
) -> StartPersonTrackingResponseTypeDef:  # (3)
    ...

1. See VideoTypeDef
2. See NotificationChannelTypeDef
3. See StartPersonTrackingResponseTypeDef

# start_person_tracking method usage example with argument unpacking

kwargs: StartPersonTrackingRequestTypeDef = {  # (1)
    "Video": ...,
}

parent.start_person_tracking(**kwargs)

1. See StartPersonTrackingRequestTypeDef

start_project_version

This operation applies only to Amazon Rekognition Custom Labels.

Type annotations and code completion for boto3.client("rekognition").start_project_version method. boto3 documentation

# start_project_version method definition

def start_project_version(
    self,
    *,
    ProjectVersionArn: str,
    MinInferenceUnits: int,
    MaxInferenceUnits: int = ...,
) -> StartProjectVersionResponseTypeDef:  # (1)
    ...

1. See StartProjectVersionResponseTypeDef

# start_project_version method usage example with argument unpacking

kwargs: StartProjectVersionRequestTypeDef = {  # (1)
    "ProjectVersionArn": ...,
    "MinInferenceUnits": ...,
}

parent.start_project_version(**kwargs)

1. See StartProjectVersionRequestTypeDef

start_segment_detection

Starts asynchronous detection of segment detection in a stored video.

Type annotations and code completion for boto3.client("rekognition").start_segment_detection method. boto3 documentation

# start_segment_detection method definition

def start_segment_detection(
    self,
    *,
    Video: VideoTypeDef,  # (1)
    SegmentTypes: Sequence[SegmentTypeType],  # (2)
    ClientRequestToken: str = ...,
    NotificationChannel: NotificationChannelTypeDef = ...,  # (3)
    JobTag: str = ...,
    Filters: StartSegmentDetectionFiltersTypeDef = ...,  # (4)
) -> StartSegmentDetectionResponseTypeDef:  # (5)
    ...

1. See VideoTypeDef
2. See Sequence[SegmentTypeType]
3. See NotificationChannelTypeDef
4. See StartSegmentDetectionFiltersTypeDef
5. See StartSegmentDetectionResponseTypeDef

# start_segment_detection method usage example with argument unpacking

kwargs: StartSegmentDetectionRequestTypeDef = {  # (1)
    "Video": ...,
    "SegmentTypes": ...,
}

parent.start_segment_detection(**kwargs)

1. See StartSegmentDetectionRequestTypeDef

start_stream_processor

Starts processing a stream processor.

Type annotations and code completion for boto3.client("rekognition").start_stream_processor method. boto3 documentation

# start_stream_processor method definition

def start_stream_processor(
    self,
    *,
    Name: str,
    StartSelector: StreamProcessingStartSelectorTypeDef = ...,  # (1)
    StopSelector: StreamProcessingStopSelectorTypeDef = ...,  # (2)
) -> StartStreamProcessorResponseTypeDef:  # (3)
    ...

1. See StreamProcessingStartSelectorTypeDef
2. See StreamProcessingStopSelectorTypeDef
3. See StartStreamProcessorResponseTypeDef

# start_stream_processor method usage example with argument unpacking

kwargs: StartStreamProcessorRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.start_stream_processor(**kwargs)

1. See StartStreamProcessorRequestTypeDef

start_text_detection

Starts asynchronous detection of text in a stored video.

Type annotations and code completion for boto3.client("rekognition").start_text_detection method. boto3 documentation

# start_text_detection method definition

def start_text_detection(
    self,
    *,
    Video: VideoTypeDef,  # (1)
    ClientRequestToken: str = ...,
    NotificationChannel: NotificationChannelTypeDef = ...,  # (2)
    JobTag: str = ...,
    Filters: StartTextDetectionFiltersTypeDef = ...,  # (3)
) -> StartTextDetectionResponseTypeDef:  # (4)
    ...

1. See VideoTypeDef
2. See NotificationChannelTypeDef
3. See StartTextDetectionFiltersTypeDef
4. See StartTextDetectionResponseTypeDef

# start_text_detection method usage example with argument unpacking

kwargs: StartTextDetectionRequestTypeDef = {  # (1)
    "Video": ...,
}

parent.start_text_detection(**kwargs)

1. See StartTextDetectionRequestTypeDef

stop_project_version

This operation applies only to Amazon Rekognition Custom Labels.

Type annotations and code completion for boto3.client("rekognition").stop_project_version method. boto3 documentation

# stop_project_version method definition

def stop_project_version(
    self,
    *,
    ProjectVersionArn: str,
) -> StopProjectVersionResponseTypeDef:  # (1)
    ...

1. See StopProjectVersionResponseTypeDef

# stop_project_version method usage example with argument unpacking

kwargs: StopProjectVersionRequestTypeDef = {  # (1)
    "ProjectVersionArn": ...,
}

parent.stop_project_version(**kwargs)

1. See StopProjectVersionRequestTypeDef

stop_stream_processor

Stops a running stream processor that was created by CreateStreamProcessor.

Type annotations and code completion for boto3.client("rekognition").stop_stream_processor method. boto3 documentation

# stop_stream_processor method definition

def stop_stream_processor(
    self,
    *,
    Name: str,
) -> Dict[str, Any]:
    ...

# stop_stream_processor method usage example with argument unpacking

kwargs: StopStreamProcessorRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.stop_stream_processor(**kwargs)

1. See StopStreamProcessorRequestTypeDef

tag_resource

Adds one or more key-value tags to an Amazon Rekognition collection, stream processor, or Custom Labels model.

Type annotations and code completion for boto3.client("rekognition").tag_resource method. boto3 documentation

# tag_resource method definition

def tag_resource(
    self,
    *,
    ResourceArn: str,
    Tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

# tag_resource method usage example with argument unpacking

kwargs: TagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "Tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestTypeDef

untag_resource

Removes one or more tags from an Amazon Rekognition collection, stream processor, or Custom Labels model.

Type annotations and code completion for boto3.client("rekognition").untag_resource method. boto3 documentation

# untag_resource method definition

def untag_resource(
    self,
    *,
    ResourceArn: str,
    TagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceRequestTypeDef = {  # (1)
    "ResourceArn": ...,
    "TagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestTypeDef

update_dataset_entries

This operation applies only to Amazon Rekognition Custom Labels.

Type annotations and code completion for boto3.client("rekognition").update_dataset_entries method. boto3 documentation

# update_dataset_entries method definition

def update_dataset_entries(
    self,
    *,
    DatasetArn: str,
    Changes: DatasetChangesTypeDef,  # (1)
) -> Dict[str, Any]:
    ...

1. See DatasetChangesTypeDef

# update_dataset_entries method usage example with argument unpacking

kwargs: UpdateDatasetEntriesRequestTypeDef = {  # (1)
    "DatasetArn": ...,
    "Changes": ...,
}

parent.update_dataset_entries(**kwargs)

1. See UpdateDatasetEntriesRequestTypeDef

update_stream_processor

Allows you to update a stream processor.

Type annotations and code completion for boto3.client("rekognition").update_stream_processor method. boto3 documentation

# update_stream_processor method definition

def update_stream_processor(
    self,
    *,
    Name: str,
    SettingsForUpdate: StreamProcessorSettingsForUpdateTypeDef = ...,  # (1)
    RegionsOfInterestForUpdate: Sequence[RegionOfInterestUnionTypeDef] = ...,  # (2)
    DataSharingPreferenceForUpdate: StreamProcessorDataSharingPreferenceTypeDef = ...,  # (3)
    ParametersToDelete: Sequence[StreamProcessorParameterToDeleteType] = ...,  # (4)
) -> Dict[str, Any]:
    ...

1. See StreamProcessorSettingsForUpdateTypeDef
2. See Sequence[RegionOfInterestUnionTypeDef]
3. See StreamProcessorDataSharingPreferenceTypeDef
4. See Sequence[StreamProcessorParameterToDeleteType]

# update_stream_processor method usage example with argument unpacking

kwargs: UpdateStreamProcessorRequestTypeDef = {  # (1)
    "Name": ...,
}

parent.update_stream_processor(**kwargs)

1. See UpdateStreamProcessorRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("rekognition").get_paginator method with overloads.

• client.get_paginator("describe_project_versions") -> DescribeProjectVersionsPaginator
• client.get_paginator("describe_projects") -> DescribeProjectsPaginator
• client.get_paginator("list_collections") -> ListCollectionsPaginator
• client.get_paginator("list_dataset_entries") -> ListDatasetEntriesPaginator
• client.get_paginator("list_dataset_labels") -> ListDatasetLabelsPaginator
• client.get_paginator("list_faces") -> ListFacesPaginator
• client.get_paginator("list_project_policies") -> ListProjectPoliciesPaginator
• client.get_paginator("list_stream_processors") -> ListStreamProcessorsPaginator
• client.get_paginator("list_users") -> ListUsersPaginator

get_waiter

Type annotations and code completion for boto3.client("rekognition").get_waiter method with overloads.

• client.get_waiter("project_version_running") -> ProjectVersionRunningWaiter
• client.get_waiter("project_version_training_completed") -> ProjectVersionTrainingCompletedWaiter