IRekognitionClient
Interface in AWS.Rekognition
Interface for Rekognition service client.
Methods
AssociateFaces
function AssociateFaces( const ARequest: IRekognitionAssociateFacesRequest): IRekognitionAssociateFacesResponse; overload;
IRekognitionAssociateFacesRequest → IRekognitionAssociateFacesResponse
Associate one of more faces with an existing user ID.
Parameters
| Name | Description |
|---|---|
ARequest | A AssociateFaces request object. |
Returns
Response containing AssociateFaces results.
function AssociateFaces(const ACollectionId: string; const AFaceIds: array of string; const AUserId: string): IRekognitionAssociateFacesResponse; overload;
IRekognitionAssociateFacesResponse
Associate one of more faces with an existing user ID.
Parameters
| Name | Description |
|---|---|
ACollectionId | Specify the IP of an existing collection containing the UserId. |
AFaceIds | Specify a list of FaceIDs to associate with the UserId. |
AUserId | Specify the ID of the existing user. |
Returns
Response containing AssociateFaces results.
CompareFaces
function CompareFaces( const ARequest: IRekognitionCompareFacesRequest): IRekognitionCompareFacesResponse; overload;
IRekognitionCompareFacesRequest → IRekognitionCompareFacesResponse
Compare a face in the source image with each of the 100 largest faces detected in the target image.
Parameters
| Name | Description |
|---|---|
ARequest | A CompareFaces request object. |
Returns
Response containing CompareFaces results.
function CompareFaces( const ASourceImage, ATargetImage: IRekognitionImage): IRekognitionCompareFacesResponse; overload;
IRekognitionImage → IRekognitionCompareFacesResponse
Compare a face in the source image with each of the 100 largest faces detected in the target image.
Parameters
| Name | Description |
|---|---|
ASourceImage | Specify an input source image to compare. |
ATargetImage | Specify an input target image to compare. |
Returns
Response containing CompareFaces results.
CreateCollection
function CreateCollection( const ARequest: IRekognitionCreateCollectionRequest): IRekognitionCreateCollectionResponse; overload;
IRekognitionCreateCollectionRequest → IRekognitionCreateCollectionResponse
Create a collection.
Parameters
| Name | Description |
|---|---|
ARequest | A CreateCollection request object. |
Returns
Response containing CreateCollection results.
function CreateCollection( const ACollectionId: string): IRekognitionCreateCollectionResponse; overload;
IRekognitionCreateCollectionResponse
Create a collection.
Parameters
| Name | Description |
|---|---|
ACollectionId | Specify the ID for the collection to create. |
Returns
Response containing CreateCollection results.
CreateUser
function CreateUser( const ARequest: IRekognitionCreateUserRequest): IRekognitionCreateUserResponse; overload;
IRekognitionCreateUserRequest → IRekognitionCreateUserResponse
Create a new User within a collection.
Parameters
| Name | Description |
|---|---|
ARequest | A CreateUser request object. |
Returns
Response containing CreateUser results.
function CreateUser( const ACollectionId, AUserId: string): IRekognitionCreateUserResponse; overload;
IRekognitionCreateUserResponse
Create a new User within a collection.
Parameters
| Name | Description |
|---|---|
ACollectionId | Specify the ID of an existing collection in which to create the user. |
AUserId | Specify the ID for a user to be created. Must be unique within the collection. |
Returns
Response containing CreateUser results.
DeleteCollection
function DeleteCollection( const ARequest: IRekognitionDeleteCollectionRequest): IRekognitionDeleteCollectionResponse; overload;
IRekognitionDeleteCollectionRequest → IRekognitionDeleteCollectionResponse
Delete a collection.
Parameters
| Name | Description |
|---|---|
ARequest | A DeleteCollection request object. |
Returns
Response containing DeleteCollection results.
function DeleteCollection( const ACollectionId: string): IRekognitionDeleteCollectionResponse; overload;
IRekognitionDeleteCollectionResponse
Delete a collection.
Parameters
| Name | Description |
|---|---|
ACollectionId | Specify the ID of an existing collection to delete. |
Returns
Response containing DeleteCollection results.
DeleteFaces
function DeleteFaces( const ARequest: IRekognitionDeleteFacesRequest): IRekognitionDeleteFacesResponse; overload;
IRekognitionDeleteFacesRequest → IRekognitionDeleteFacesResponse
Delete faces from a collection.
Parameters
| Name | Description |
|---|---|
ARequest | A DeleteFaces request object. |
Returns
Response containing DeleteFaces results.
function DeleteFaces(const ACollectionId: string; const AFaceIds: array of string): IRekognitionDeleteFacesResponse; overload;
IRekognitionDeleteFacesResponse
Delete faces from a collection.
Parameters
| Name | Description |
|---|---|
ACollectionId | Specify the ID of an existing collection to remove faces from. |
AFaceIds | Specify a list of IDs of faces to delete. |
Returns
Response containing DeleteFaces results.
DeleteUser
function DeleteUser( const ARequest: IRekognitionDeleteUserRequest): IRekognitionDeleteUserResponse; overload;
IRekognitionDeleteUserRequest → IRekognitionDeleteUserResponse
Delete a user within a collection.
Parameters
| Name | Description |
|---|---|
ARequest | A DeleteUser request object. |
Returns
Response containing DeleteUser results.
function DeleteUser( const ACollectionId, AUserId: string): IRekognitionDeleteUserResponse; overload;
IRekognitionDeleteUserResponse
Delete a user within a collection.
Parameters
| Name | Description |
|---|---|
ACollectionId | Specify the ID of an existing collection to remove user from. |
AUserId | Specify the ID of the user to be deleted. |
Returns
Response containing DeleteUser results.
DescribeCollection
function DescribeCollection( const ARequest: IRekognitionDescribeCollectionRequest): IRekognitionDescribeCollectionResponse; overload;
IRekognitionDescribeCollectionRequest → IRekognitionDescribeCollectionResponse
Describe a collection.
Parameters
| Name | Description |
|---|---|
ARequest | A DescribeCollection request object. |
Returns
Response containing DescribeCollection results.
function DescribeCollection( const ACollectionId: string): IRekognitionDescribeCollectionResponse; overload;
IRekognitionDescribeCollectionResponse
Describe a collection.
Parameters
| Name | Description |
|---|---|
ACollectionId | Specify the ID of an existing collection describe. |
Returns
Response containing DescribeCollection results.
DetectFaces
function DetectFaces( const ARequest: IRekognitionDetectFacesRequest): IRekognitionDetectFacesResponse; overload;
IRekognitionDetectFacesRequest → IRekognitionDetectFacesResponse
Detect faces within an image.
Parameters
| Name | Description |
|---|---|
ARequest | A DetectFaces request object. |
Returns
Response containing DetectFaces results.
function DetectFaces(const AImage: IRekognitionImage): IRekognitionDetectFacesResponse; overload;
IRekognitionImage → IRekognitionDetectFacesResponse
Detect faces within an image.
Parameters
| Name | Description |
|---|---|
AImage | Specify an input image to detect faces within. |
Returns
Response containing DetectFaces results.
function DetectFaces(const AImage: IRekognitionImage; const AAttributes: array of string): IRekognitionDetectFacesResponse; overload;
IRekognitionImage → IRekognitionDetectFacesResponse
Detect faces within an image.
Parameters
| Name | Description |
|---|---|
AImage | Specify an input image to detect faces within. |
AAttributes | Specify a list of attributes you want to be returned. Valid values:|||||||||||||. |
Returns
Response containing DetectFaces results.
DetectLabels
function DetectLabels( const ARequest: IRekognitionDetectLabelsRequest): IRekognitionDetectLabelsResponse; overload;
IRekognitionDetectLabelsRequest → IRekognitionDetectLabelsResponse
Detect instances of real-world entities within an image provided as input.
Parameters
| Name | Description |
|---|---|
ARequest | A DetectLabels request object. |
Returns
Response containing DetectLabels results.
function DetectLabels( const AImage: IRekognitionImage): IRekognitionDetectLabelsResponse; overload;
IRekognitionImage → IRekognitionDetectLabelsResponse
Detect instances of real-world entities within an image provided as input.
Parameters
| Name | Description |
|---|---|
AImage | Specify an input image to detect entities within. |
Returns
Response containing DetectLabels results.
function DetectLabels(const AImage: IRekognitionImage; const AFeatures: array of string): IRekognitionDetectLabelsResponse; overload;
IRekognitionImage → IRekognitionDetectLabelsResponse
Detect instances of real-world entities within an image provided as input.
Parameters
| Name | Description |
|---|---|
AImage | Specify an input image to detect entities within. |
AFeatures | Specify a list of types of analysis to perform. Valid values:|. |
Returns
Response containing DetectLabels results.
DetectModerationLabels
function DetectModerationLabels( const ARequest: IRekognitionDetectModerationLabelsRequest): IRekognitionDetectModerationLabelsResponse; overload;
IRekognitionDetectModerationLabelsRequest → IRekognitionDetectModerationLabelsResponse
Detect unsafe content in an image.
Parameters
| Name | Description |
|---|---|
ARequest | A DetectModerationLabels request object. |
Returns
Response containing DetectModerationLabels results.
function DetectModerationLabels( const AImage: IRekognitionImage): IRekognitionDetectModerationLabelsResponse; overload;
IRekognitionImage → IRekognitionDetectModerationLabelsResponse
Detect unsafe content in an image.
Parameters
| Name | Description |
|---|---|
AImage | Specify an input image to detect unsafe content within. |
Returns
Response containing DetectModerationLabels results.
DetectProtectiveEquipment
function DetectProtectiveEquipment( const ARequest: IRekognitionDetectProtectiveEquipmentRequest): IRekognitionDetectProtectiveEquipmentResponse; overload;
IRekognitionDetectProtectiveEquipmentRequest → IRekognitionDetectProtectiveEquipmentResponse
Detect Personal Protective Equipment (PPE) worn by people detected in an image.
Parameters
| Name | Description |
|---|---|
ARequest | A DetectProtectiveEquipment request object. |
Returns
Response containing DetectProtectiveEquipment results.
function DetectProtectiveEquipment(const AImage: IRekognitionImage; const ASummarizationAttributes: IRekognitionProtectiveEquipmentSummarizationAttributes = nil): IRekognitionDetectProtectiveEquipmentResponse; overload;
IRekognitionImage, IRekognitionProtectiveEquipmentSummarizationAttributes → IRekognitionDetectProtectiveEquipmentResponse
Detect Personal Protective Equipment (PPE) worn by people detected in an image.
Parameters
| Name | Description |
|---|---|
AImage | Specify an input image to detect Personal Protective Equipment (PPE) within. |
ASummarizationAttributes | Optionally, specify a list of PPE types that you want to summarize. |
Returns
Response containing DetectProtectiveEquipment results.
DetectText
function DetectText( const ARequest: IRekognitionDetectTextRequest): IRekognitionDetectTextResponse; overload;
IRekognitionDetectTextRequest → IRekognitionDetectTextResponse
Detect text in an input image.
Parameters
| Name | Description |
|---|---|
ARequest | A DetectText request object. |
Returns
Response containing DetectText results.
function DetectText(const AImage: IRekognitionImage; const AFilters: IRekognitionDetectTextFilters = nil): IRekognitionDetectTextResponse; overload;
IRekognitionImage, IRekognitionDetectTextFilters → IRekognitionDetectTextResponse
Detect text in an input image.
Parameters
| Name | Description |
|---|---|
AImage | Specify an input image to detect Personal Protective Equipment (PPE) within. |
AFilters | Optionally, specify criteria that the text must meet to be included in the response. |
Returns
Response containing DetectText results.
DisassociateFaces
function DisassociateFaces( const ARequest: IRekognitionDisassociateFacesRequest): IRekognitionDisassociateFacesResponse; overload;
IRekognitionDisassociateFacesRequest → IRekognitionDisassociateFacesResponse
Remove the association between one or more faces with an existing user ID.
Parameters
| Name | Description |
|---|---|
ARequest | A DisassociateFaces request object. |
Returns
Response containing AssociateFaces results.
function DisassociateFaces(const ACollectionId: string; const AFaceIds: array of string; const AUserId: string): IRekognitionDisassociateFacesResponse; overload;
IRekognitionDisassociateFacesResponse
Remove the association between one or more faces with an existing user ID.
Parameters
| Name | Description |
|---|---|
ACollectionId | Specify the IP of an existing collection containing the UserId. |
AFaceIds | Specify a list of FaceIDs to disassociate with the UserId. |
AUserId | Specify the ID of the existing user. |
Returns
Response containing AssociateFaces results.
GetCelebrityInfo
function GetCelebrityInfo( const ARequest: IRekognitionGetCelebrityInfoRequest): IRekognitionGetCelebrityInfoResponse; overload;
IRekognitionGetCelebrityInfoRequest → IRekognitionGetCelebrityInfoResponse
Get the name and additonal information about a celebrity based on their Amazon Rekognition ID.
Parameters
| Name | Description |
|---|---|
ARequest | A GetCelebrityInfo request object. |
Returns
Response containing GetCelebrityInfo results.
function GetCelebrityInfo( const AId: string): IRekognitionGetCelebrityInfoResponse; overload;
IRekognitionGetCelebrityInfoResponse
Get the name and additonal information about a celebrity based on their Amazon Rekognition ID.
Parameters
| Name | Description |
|---|---|
AId | Specify the ID of the celebrity as returned by calling RecognizeCelebrities. |
Returns
Response containing GetCelebrityInfo results.
GetMediaAnalysisJob
function GetMediaAnalysisJob( const ARequest: IRekognitionGetMediaAnalysisJobRequest): IRekognitionGetMediaAnalysisJobResponse; overload;
IRekognitionGetMediaAnalysisJobRequest → IRekognitionGetMediaAnalysisJobResponse
Retrieve the results for a given media analysis job.
Parameters
| Name | Description |
|---|---|
ARequest | A GetMediaAnalysisJob request object. |
Returns
Response containing GetMediaAnalysisJob results.
function GetMediaAnalysisJob( const AJobId: string): IRekognitionGetMediaAnalysisJobResponse; overload;
IRekognitionGetMediaAnalysisJobResponse
Retrieve the results for a given media analysis job.
Parameters
| Name | Description |
|---|---|
AJobId | Specify the unique identifier for the media analysis job to retrieve. |
Returns
Response containing GetMediaAnalysisJob results.
IndexFaces
function IndexFaces( const ARequest: IRekognitionIndexFacesRequest): IRekognitionIndexFacesResponse; overload;
IRekognitionIndexFacesRequest → IRekognitionIndexFacesResponse
Detect faces in an input image and add them to a collection.
Parameters
| Name | Description |
|---|---|
ARequest | A IndexFaces request object. |
Returns
Response containing IndexFaces results.
function IndexFaces(const ACollectionId: string; const AImage: IRekognitionImage): IRekognitionIndexFacesResponse; overload;
IRekognitionImage → IRekognitionIndexFacesResponse
Detect faces in an input image and add them to a collection.
Parameters
| Name | Description |
|---|---|
ACollectionId | Specify the ID of an existing collection to add detected faces to. |
AImage | Specify an input image to detect faces within. |
Returns
Response containing IndexFaces results.
ListCollections
function ListCollections( const ARequest: IRekognitionListCollectionsRequest): IRekognitionListCollectionsResponse; overload;
IRekognitionListCollectionsRequest → IRekognitionListCollectionsResponse
Fetch a list of collection IDs in your account.
Parameters
| Name | Description |
|---|---|
ARequest | A ListCollections request object. |
Returns
Response containing ListCollections results.
function ListCollections(const AMaxResults: Integer; const ANextToken: string = ''): IRekognitionListCollectionsResponse; overload;
IRekognitionListCollectionsResponse
Fetch a list of collection IDs in your account.
Parameters
| Name | Description |
|---|---|
AMaxResults | Specify the maximum number of results to return. Valid range: 0 - 4096. |
ANextToken | Specify the NextToken from a previous response to fetch the next page of results. |
Returns
Response containing ListCollections results.
ListMediaAnalysisJobs
function ListMediaAnalysisJobs( const ARequest: IRekognitionListMediaAnalysisJobsRequest): IRekognitionListMediaAnalysisJobsResponse; overload;
IRekognitionListMediaAnalysisJobsRequest → IRekognitionListMediaAnalysisJobsResponse
Fetch a list of media analysis jobs.
Parameters
| Name | Description |
|---|---|
ARequest | A ListMediaAnalysisJobs request object. |
Returns
Response containing ListMediaAnalysisJobs results.
function ListMediaAnalysisJobs(const AMaxResults: Integer; const ANextToken: string = ''): IRekognitionListMediaAnalysisJobsResponse; overload;
IRekognitionListMediaAnalysisJobsResponse
Fetch a list of media analysis jobs.
Parameters
| Name | Description |
|---|---|
AMaxResults | Specify the maximum number of results to return. Valid range: 1 - 100. |
ANextToken | Specify the NextToken from a previous response to fetch the next page of results. |
Returns
Response containing ListMediaAnalysisJobs results.
ListFaces
function ListFaces( const ARequest: IRekognitionListFacesRequest): IRekognitionListFacesResponse; overload;
IRekognitionListFacesRequest → IRekognitionListFacesResponse
Fetch a list of metadata about faces in a collection.
Parameters
| Name | Description |
|---|---|
ARequest | A ListFaces request object. |
Returns
Response containing ListFaces results.
function ListFaces( const ACollectionId: string): IRekognitionListFacesResponse; overload;
Fetch a list of metadata about faces in a collection.
Parameters
| Name | Description |
|---|---|
ACollectionId | Specify the ID of the collection to return faces from. |
Returns
Response containing ListFaces results.
function ListFaces(const ACollectionId: string; const AMaxResults: Integer; const ANextToken: string = ''): IRekognitionListFacesResponse; overload;
Fetch a list of metadata about faces in a collection.
Parameters
| Name | Description |
|---|---|
ACollectionId | Specify the ID of the collection to return faces from. |
AMaxResults | Specify the maximum number of results to return. Valid range: 0 - 4096. |
ANextToken | Specify the NextToken from a previous response to fetch the next page of results. |
Returns
Response containing ListFaces results.
ListUsers
function ListUsers( const ARequest: IRekognitionListUsersRequest): IRekognitionListUsersResponse; overload;
IRekognitionListUsersRequest → IRekognitionListUsersResponse
Fetch a list of metadata about UserIDs in a collection.
Parameters
| Name | Description |
|---|---|
ARequest | A ListUsers request object. |
Returns
Response containing ListUsers results.
function ListUsers( const ACollectionId: string): IRekognitionListUsersResponse; overload;
Fetch a list of metadata about users in a collection.
Parameters
| Name | Description |
|---|---|
ACollectionId | Specify the ID of the collection to return UserIDs from. |
Returns
Response containing ListUsers results.
function ListUsers(const ACollectionId: string; const AMaxResults: Integer; const ANextToken: string = ''): IRekognitionListUsersResponse; overload;
Fetch a list of metadata about UserIDs in a collection.
Parameters
| Name | Description |
|---|---|
ACollectionId | Specify the ID of the collection to return UserIDs from. |
AMaxResults | Specify the maximum number of results to return. Valid range: 0 - 4096. |
ANextToken | Specify the NextToken from a previous response to fetch the next page of results. |
Returns
Response containing ListUsers results.
RecognizeCelebrities
function RecognizeCelebrities( const ARequest: IRekognitionRecognizeCelebritiesRequest): IRekognitionRecognizeCelebritiesResponse; overload;
IRekognitionRecognizeCelebritiesRequest → IRekognitionRecognizeCelebritiesResponse
Detect celebrities within an image.
Parameters
| Name | Description |
|---|---|
ARequest | A RecognizeCelebrities request object. |
Returns
Response containing RecognizeCelebrities results.
function RecognizeCelebrities( const AImage: IRekognitionImage): IRekognitionRecognizeCelebritiesResponse; overload;
IRekognitionImage → IRekognitionRecognizeCelebritiesResponse
Detect celebrities within an image.
Parameters
| Name | Description |
|---|---|
AImage | Specify an input image to detect celebrities within. |
Returns
Response containing RecognizeCelebrities results.
SearchFaces
function SearchFaces( const ARequest: IRekognitionSearchFacesRequest): IRekognitionSearchFacesResponse; overload;
IRekognitionSearchFacesRequest → IRekognitionSearchFacesResponse
Search for a face within a collection.
Parameters
| Name | Description |
|---|---|
ARequest | A SearchFaces request object. |
Returns
Response containing SearchFaces results.
function SearchFaces( const ACollectionId, AFaceId: string): IRekognitionSearchFacesResponse; overload;
IRekognitionSearchFacesResponse
Search for a face within a collection.
Parameters
| Name | Description |
|---|---|
ACollectionId | Specify the ID of a collection to search for faces in. |
AFaceId | Specify the ID of a face to search for within the collection. |
Returns
Response containing SearchFaces results.
SearchFacesByImage
function SearchFacesByImage( const ARequest: IRekognitionSearchFacesByImageRequest): IRekognitionSearchFacesByImageResponse; overload;
IRekognitionSearchFacesByImageRequest → IRekognitionSearchFacesByImageResponse
Search for a face from an image within a collection.
Parameters
| Name | Description |
|---|---|
ARequest | A SearchFacesByImage request object. |
Returns
Response containing SearchFacesByImage results.
function SearchFacesByImage(const ACollectionId: string; const AImage: IRekognitionImage): IRekognitionSearchFacesByImageResponse; overload;
IRekognitionImage → IRekognitionSearchFacesByImageResponse
Search for a face from an image within a collection.
Parameters
| Name | Description |
|---|---|
ACollectionId | Specify the ID of a collection to search for faces in. |
AImage | Specify an image to detect the the search image from. |
Returns
Response containing SearchFacesByImage results.
SearchUsers
function SearchUsers( const ARequest: IRekognitionSearchUsersRequest): IRekognitionSearchUsersResponse;
IRekognitionSearchUsersRequest → IRekognitionSearchUsersResponse
Search for UserIDs within a collection by face ID or UserID.
Parameters
| Name | Description |
|---|---|
ARequest | A SearchUsers request object. |
Returns
Response containing SearchUsers results.
SearchUsersByImage
function SearchUsersByImage( const ARequest: IRekognitionSearchUsersByImageRequest): IRekognitionSearchUsersByImageResponse; overload;
IRekognitionSearchUsersByImageRequest → IRekognitionSearchUsersByImageResponse
Search for UserIDs from an image within a collection.
Parameters
| Name | Description |
|---|---|
ARequest | A SearchUsersByImage request object. |
Returns
Response containing SearchUsersByImage results.
function SearchUsersByImage(const ACollectionId: string; const AImage: IRekognitionImage): IRekognitionSearchUsersByImageResponse; overload;
IRekognitionImage → IRekognitionSearchUsersByImageResponse
Search for UserIDs from an image within a collection.
Parameters
| Name | Description |
|---|---|
ACollectionId | Specify the ID of a collection to search for UserIDs in. |
AImage | Specify an image to detect the the search image from. |
Returns
Response containing SearchUsersByImage results.
StartMediaAnalysisJob
function StartMediaAnalysisJob( const ARequest: IRekognitionStartMediaAnalysisJobRequest): IRekognitionStartMediaAnalysisJobResponse; overload;
IRekognitionStartMediaAnalysisJobRequest → IRekognitionStartMediaAnalysisJobResponse
Start a new media analysis job.
Parameters
| Name | Description |
|---|---|
ARequest | A StartMediaAnalysisJob request object. |
Returns
Response containing StartMediaAnalysisJob results.
function StartMediaAnalysisJob(const AInput: IRekognitionMediaAnalysisInput; const AOutputConfig: IRekognitionMediaAnalysisOutputConfig): IRekognitionStartMediaAnalysisJobResponse; overload;
IRekognitionMediaAnalysisInput, IRekognitionMediaAnalysisOutputConfig → IRekognitionStartMediaAnalysisJobResponse
Start a new media analysis job.
Parameters
| Name | Description |
|---|---|
AInput | Specify the input for the media analysis job. |
AOutputConfig | Specify the output configuration for the media analysis job. |
Returns
Response containing StartMediaAnalysisJob results.
CopyProjectVersion
function CopyProjectVersion(const ARequest: IRekognitionCopyProjectVersionRequest): IRekognitionCopyProjectVersionResponse; overload;
IRekognitionCopyProjectVersionRequest → IRekognitionCopyProjectVersionResponse
Copy a version of an Amazon Rekognition Custom Labels model from a source project to a destination project.
Parameters
| Name | Description |
|---|---|
ARequest | A CopyProjectVersion request object. |
Returns
Response containing CopyProjectVersion results.
function CopyProjectVersion(const ASourceProjectArn, ASourceProjectVersionArn, ADestinationProjectArn: TARN; const AVersionName: string; const AOutputConfig: IRekognitionOutputConfig): IRekognitionCopyProjectVersionResponse; overload;
IRekognitionOutputConfig → IRekognitionCopyProjectVersionResponse
Copy a version of an Amazon Rekognition Custom Labels model from a source project to a destination project.
Parameters
| Name | Description |
|---|---|
ASourceProjectArn | Specify the Amazon Resource Name (ARN) of the project you want to copy the model version from. |
ASourceProjectVersionArn | Specify the Amazon Resource Name (ARN) of the model version in the source project you want to copy. |
ADestinationProjectArn | Specify the Amazon Resource Name (ARN) of the project you want to copy the model version to. |
AVersionName | Specify the name for the version of the model that's copied to the destination project. |
AOutputConfig | Specify the S3 bucket and prefix where you want to store the training output for the source model version. |
Returns
Response containing CopyProjectVersion results.
CreateDataset
function CreateDataset( const ARequest: IRekognitionCreateDatasetRequest): IRekognitionCreateDatasetResponse; overload;
IRekognitionCreateDatasetRequest → IRekognitionCreateDatasetResponse
Create a new Amazon Rekognition Custom Labels dataset.
Parameters
| Name | Description |
|---|---|
ARequest | A CreateDataset request object. |
Returns
Response containing CreateDataset results.
function CreateDataset(const ADatasetType: string; const AProjectArn: TARN; const ADatasetSource: IRekognitionDatasetSource = nil): IRekognitionCreateDatasetResponse; overload;
IRekognitionDatasetSource → IRekognitionCreateDatasetResponse
Create a new Amazon Rekognition Custom Labels dataset.
Parameters
| Name | Description |
|---|---|
ADatasetType | Specify the type of dataset to create. |
AProjectArn | Specify the Amazon Resource Name (ARN) of the Amazon Rekognition Custom Labels project to assign the dataset to. |
ADatasetSource | Optionally, specify a source for the dataset. If not specified, an empty dataset will be created. |
Returns
Response containing CreateDataset results.
CreateProject
function CreateProject( const ARequest: IRekognitionCreateProjectRequest): IRekognitionCreateProjectResponse; overload;
IRekognitionCreateProjectRequest → IRekognitionCreateProjectResponse
Create a new Amazon Rekognition project.
Parameters
| Name | Description |
|---|---|
ARequest | A CreateProject request object. |
Returns
Response containing CreateProject results.
function CreateProject( const AProjectName: string): IRekognitionCreateProjectResponse; overload;
IRekognitionCreateProjectResponse
Create a new Amazon Rekognition project.
Parameters
| Name | Description |
|---|---|
AProjectName | Specify a name for the project. |
Returns
Response containing CreateProject results.
CreateProjectVersion
function CreateProjectVersion( const ARequest: IRekognitionCreateProjectVersionRequest): IRekognitionCreateProjectVersionResponse;
IRekognitionCreateProjectVersionRequest → IRekognitionCreateProjectVersionResponse
Create a new version of an Amazon Rekognition project (like Custom Labels model or a custom adapter) and begins training.
Parameters
| Name | Description |
|---|---|
ARequest | A CreateProjectVersion request object. |
Returns
Response containing CreateProjectVersion results.
DeleteDataset
function DeleteDataset( const ARequest: IRekognitionDeleteDatasetRequest): IRekognitionDeleteDatasetResponse; overload;
IRekognitionDeleteDatasetRequest → IRekognitionDeleteDatasetResponse
Delete an existing Amazon Rekognition Custom Labels dataset.
Parameters
| Name | Description |
|---|---|
ARequest | A DeleteDataset request object. |
Returns
Response containing DeleteDataset results.
function DeleteDataset( const ADatasetArn: TARN): IRekognitionDeleteDatasetResponse; overload;
IRekognitionDeleteDatasetResponse
Delete an existing Amazon Rekognition Custom Labels dataset.
Parameters
| Name | Description |
|---|---|
ADatasetArn | Specify the Amazon Resource Name (ARN) of an Amazon Rekognition Custom Labels dataset that you want to delete. |
Returns
Response containing DeleteDataset results.
DeleteProject
function DeleteProject( const ARequest: IRekognitionDeleteProjectRequest): IRekognitionDeleteProjectResponse; overload;
IRekognitionDeleteProjectRequest → IRekognitionDeleteProjectResponse
Delete an Amazon Rekognition project.
You must first delete all models or adapters associated with a project. Associated ProjectPolicies will be deleted automatically. DeleteProject is an asynchronous action. Call DescribeProjects to check the status.
Parameters
| Name | Description |
|---|---|
ARequest | A DeleteProject request object. |
Returns
Response containing DeleteProject results.
function DeleteProject( const AProjectArn: TARN): IRekognitionDeleteProjectResponse; overload;
IRekognitionDeleteProjectResponse
Delete an Amazon Rekognition project.
You must first delete all models or adapters associated with a project. Associated ProjectPolicies will be deleted automatically. DeleteProject is an asynchronous action. Call DescribeProjects to check the status.
Parameters
| Name | Description |
|---|---|
AProjectArn | Specify the Amazon Resource Name (ARN) of an Amazon Rekognition project that you want to delete. |
Returns
Response containing DeleteProject results.
DeleteProjectPolicy
function DeleteProjectPolicy( const ARequest: IRekognitionDeleteProjectPolicyRequest): IRekognitionDeleteProjectPolicyResponse; overload;
IRekognitionDeleteProjectPolicyRequest → IRekognitionDeleteProjectPolicyResponse
Delete an existing project policy.
Parameters
| Name | Description |
|---|---|
ARequest | A DeleteProjectPolicy request object. |
Returns
Response containing DeleteProjectPolicy results.
function DeleteProjectPolicy(const AProjectArn: TARN; const APolicyName: string; const APolicyRevisionId: string = ''): IRekognitionDeleteProjectPolicyResponse; overload;
IRekognitionDeleteProjectPolicyResponse
Delete an existing project policy.
Parameters
| Name | Description |
|---|---|
AProjectArn | Specify the Amazon Resource Name (ARN) of an Amazon Rekognition project that the policy is attached to. |
APolicyName | Specify the name of the project policy that you want to delete. |
APolicyRevisionId | Optionally, specify the ID of the project policy revision that you want to delete. |
Returns
Response containing DeleteProjectPolicy results.
DeleteProjectVersion
function DeleteProjectVersion( const ARequest: IRekognitionDeleteProjectVersionRequest): IRekognitionDeleteProjectVersionResponse; overload;
IRekognitionDeleteProjectVersionRequest → IRekognitionDeleteProjectVersionResponse
Delete a Rekognition project model or project version.
Parameters
| Name | Description |
|---|---|
ARequest | A DeleteProjectVersion request object. |
Returns
Response containing DeleteProjectVersion results.
function DeleteProjectVersion( const AProjectVersionArn: TARN): IRekognitionDeleteProjectVersionResponse; overload;
IRekognitionDeleteProjectVersionResponse
Delete a Rekognition project model or project version.
Parameters
| Name | Description |
|---|---|
AProjectVersionArn | Specify the Amazon Resource Name (ARN) of the project version that you want to delete. |
Returns
Response containing DeleteProjectVersion results.
DescribeDataset
function DescribeDataset( const ARequest: IRekognitionDescribeDatasetRequest): IRekognitionDescribeDatasetResponse; overload;
IRekognitionDescribeDatasetRequest → IRekognitionDescribeDatasetResponse
Describe an Amazon Rekognition Custom Labels dataset.
Parameters
| Name | Description |
|---|---|
ARequest | A DescribeDataset request object. |
Returns
Response containing DescribeDataset results.
function DescribeDataset( const ADatasetArn: TARN): IRekognitionDescribeDatasetResponse; overload;
IRekognitionDescribeDatasetResponse
Describe an Amazon Rekognition Custom Labels dataset.
Parameters
| Name | Description |
|---|---|
ADatasetArn | Specify the Amazon Resource Name (ARN) of the dataset to describe. |
Returns
Response containing DescribeDataset results.
DescribeProjects
function DescribeProjects( const ARequest: IRekognitionDescribeProjectsRequest): IRekognitionDescribeProjectsResponse; overload;
IRekognitionDescribeProjectsRequest → IRekognitionDescribeProjectsResponse
Retrieve information about your Rekognition projects.
Parameters
| Name | Description |
|---|---|
ARequest | A DescribeProjects request object. |
Returns
Response containing DescribeProjects results.
function DescribeProjects(const AMaxResults: Integer; const ANextToken: string = ''): IRekognitionDescribeProjectsResponse; overload;
IRekognitionDescribeProjectsResponse
Retrieve information about your Rekognition projects.
Parameters
| Name | Description |
|---|---|
AMaxResults | Specify the maximum number of results to return. Valid range: 1 - 100. |
ANextToken | Specify the NextToken from a previous response to fetch the next page of results. |
Returns
Response containing DescribeProjects results.
DescribeProjectVersions
function DescribeProjectVersions( const ARequest: IRekognitionDescribeProjectVersionsRequest): IRekognitionDescribeProjectVersionsResponse; overload;
IRekognitionDescribeProjectVersionsRequest → IRekognitionDescribeProjectVersionsResponse
Retrieve information about the versions of an Amazon Rekognition project.
Parameters
| Name | Description |
|---|---|
ARequest | A DescribeProjectVersions request object. |
Returns
Response containing DescribeProjectVersions results.
function DescribeProjectVersions( const AProjectArn: TARN): IRekognitionDescribeProjectVersionsResponse; overload;
IRekognitionDescribeProjectVersionsResponse
Retrieve information about the versions of an Amazon Rekognition project.
Parameters
| Name | Description |
|---|---|
AProjectArn | Specify the Amazon Resource Name (ARN) of the project that contains the model/adapter you want to describe. |
Returns
Response containing DescribeProjectVersions results.
function DescribeProjectVersions(const AProjectArn: TARN; const AMaxResults: Integer; const ANextToken: string = ''): IRekognitionDescribeProjectVersionsResponse; overload;
IRekognitionDescribeProjectVersionsResponse
Retrieve information about the versions of an Amazon Rekognition project.
Parameters
| Name | Description |
|---|---|
AProjectArn | Specify the Amazon Resource Name (ARN) of the project that contains the model/adapter you want to describe. |
AMaxResults | Specify the maximum number of results to return. Valid range: 1 - 100. |
ANextToken | Specify the NextToken from a previous response to fetch the next page of results. |
Returns
Response containing DescribeProjectVersions results.
DetectCustomLabels
function DetectCustomLabels( const ARequest: IRekognitionDetectCustomLabelsRequest): IRekognitionDetectCustomLabelsResponse; overload;
IRekognitionDetectCustomLabelsRequest → IRekognitionDetectCustomLabelsResponse
Detect custom labels in a supplied image using an Amazon Rekognition Custom Labels model.
Parameters
| Name | Description |
|---|---|
ARequest | A DetectCustomLabels request object. |
Returns
Response containing DetectCustomLabels results.
function DetectCustomLabels(const AImage: IRekognitionImage; const AProjectVersionArn: TARN): IRekognitionDetectCustomLabelsResponse; overload;
IRekognitionImage → IRekognitionDetectCustomLabelsResponse
Detect custom labels in a supplied image using an Amazon Rekognition Custom Labels model.
Parameters
| Name | Description |
|---|---|
AImage | Specify an input image to detect custom labels within. |
AProjectVersionArn | Specify the Amazon Resource Name (ARN) of the model version that you want to use. |
Returns
Response containing DetectCustomLabels results.
DistributeDatasetEntries
function DistributeDatasetEntries( const ARequest: IRekognitionDistributeDatasetEntriesRequest): IRekognitionDistributeDatasetEntriesResponse; overload;
IRekognitionDistributeDatasetEntriesRequest → IRekognitionDistributeDatasetEntriesResponse
Distribute the entries (images) in a training dataset across the training dataset and test dataset for a project.
Parameters
| Name | Description |
|---|---|
ARequest | A DistributeDatasetEntries request object. |
Returns
Response containing DistributeDatasetEntries results.
function DistributeDatasetEntries( const ATrainingDatasetArn, ATestDatasetArn: TARN): IRekognitionDistributeDatasetEntriesResponse; overload;
IRekognitionDistributeDatasetEntriesResponse
Distribute the entries (images) in a training dataset across the training dataset and test dataset for a project.
Parameters
| Name | Description |
|---|---|
ATrainingDatasetArn | Specify the Amazon Resource Name (ARN) of the training dataset. |
ATestDatasetArn | Specify the Amazon Resource Name (ARN) of the test dataset. Must be empty. |
Returns
Response containing DistributeDatasetEntries results.
ListDatasetEntries
function ListDatasetEntries( const ARequest: IRekognitionListDatasetEntriesRequest): IRekognitionListDatasetEntriesResponse; overload;
IRekognitionListDatasetEntriesRequest → IRekognitionListDatasetEntriesResponse
List the entries (images) with a dataset.
Parameters
| Name | Description |
|---|---|
ARequest | A ListDatasetEntries request object. |
Returns
Response containing ListDatasetEntries results.
function ListDatasetEntries( const ADatasetArn: TARN): IRekognitionListDatasetEntriesResponse; overload;
IRekognitionListDatasetEntriesResponse
List the entries (images) with a dataset.
Parameters
| Name | Description |
|---|---|
ADatasetArn | Specify the Amazon Resource Name (ARN) for the dataset that you want to use. |
Returns
Response containing ListDatasetEntries results.
function ListDatasetEntries(const ADatasetArn: TARN; const AMaxResults: Integer; const ANextToken: string = ''): IRekognitionListDatasetEntriesResponse; overload;
IRekognitionListDatasetEntriesResponse
List the entries (images) with a dataset.
Parameters
| Name | Description |
|---|---|
ADatasetArn | Specify the Amazon Resource Name (ARN) for the dataset that you want to use. |
AMaxResults | Specify the maximum number of results to return. Valid range: 1 - 100. |
ANextToken | Specify the NextToken from a previous response to fetch the next page of results. |
Returns
Response containing ListDatasetEntries results.
ListDatasetLabels
function ListDatasetLabels( const ARequest: IRekognitionListDatasetLabelsRequest): IRekognitionListDatasetLabelsResponse; overload;
IRekognitionListDatasetLabelsRequest → IRekognitionListDatasetLabelsResponse
List the labels in a dataset.
Parameters
| Name | Description |
|---|---|
ARequest | A ListDatasetLabels request object. |
Returns
Response containing ListDatasetLabels results.
function ListDatasetLabels( const ADatasetArn: TARN): IRekognitionListDatasetLabelsResponse; overload;
IRekognitionListDatasetLabelsResponse
List the labels in a dataset.
Parameters
| Name | Description |
|---|---|
ADatasetArn | Specify the Amazon Resource Name (ARN) for the dataset that you want to use. |
Returns
Response containing ListDatasetLabels results.
function ListDatasetLabels(const ADatasetArn: TARN; const AMaxResults: Integer; const ANextToken: string = ''): IRekognitionListDatasetLabelsResponse; overload;
IRekognitionListDatasetLabelsResponse
List the labels in a dataset.
Parameters
| Name | Description |
|---|---|
ADatasetArn | Specify the Amazon Resource Name (ARN) for the dataset that you want to use. |
AMaxResults | Specify the maximum number of results to return. Valid range: 1 - 100. |
ANextToken | Specify the NextToken from a previous response to fetch the next page of results. |
Returns
Response containing ListDatasetLabels results.
ListProjectPolicies
function ListProjectPolicies( const ARequest: IRekognitionListProjectPoliciesRequest): IRekognitionListProjectPoliciesResponse; overload;
IRekognitionListProjectPoliciesRequest → IRekognitionListProjectPoliciesResponse
List the project policies attached to a project.
Parameters
| Name | Description |
|---|---|
ARequest | A ListProjectPolicies request object. |
Returns
Response containing ListProjectPolicies results.
function ListProjectPolicies( const AProjectArn: TARN): IRekognitionListProjectPoliciesResponse; overload;
IRekognitionListProjectPoliciesResponse
List the project policies attached to a project.
Parameters
| Name | Description |
|---|---|
AProjectArn | Specify the Amazon Resource Name (ARN) of the project to fetch project policies for. |
Returns
Response containing ListProjectPolicies results.
function ListProjectPolicies(const AProjectArn: TARN; const AMaxResults: Integer; const ANextToken: string = ''): IRekognitionListProjectPoliciesResponse; overload;
IRekognitionListProjectPoliciesResponse
List the project policies attached to a project.
Parameters
| Name | Description |
|---|---|
AProjectArn | Specify the Amazon Resource Name (ARN) of the project to fetch project policies for. |
AMaxResults | Specify the maximum number of results to return. Valid range: 1 - 5. |
ANextToken | Specify the NextToken from a previous response to fetch the next page of results. |
Returns
Response containing ListProjectPolicies results.
PutProjectPolicy
function PutProjectPolicy( const ARequest: IRekognitionPutProjectPolicyRequest): IRekognitionPutProjectPolicyResponse; overload;
IRekognitionPutProjectPolicyRequest → IRekognitionPutProjectPolicyResponse
Attach a project policy to an Amazon Rekognition Custom Labels project.
Parameters
| Name | Description |
|---|---|
ARequest | A PutProjectPolicy request object. |
Returns
Response containing PutProjectPolicy results.
function PutProjectPolicy(const APolicyDocument, APolicyName: string; const AProjectArn: TARN): IRekognitionPutProjectPolicyResponse; overload;
IRekognitionPutProjectPolicyResponse
Attach a project policy to an Amazon Rekognition Custom Labels project.
Parameters
| Name | Description |
|---|---|
APolicyDocument | Specify a resource policy to add to the model. The policy is a JSON stucture containing one or more statements defaining an IAM policy. |
APolicyName | Specify the name of the policy. |
AProjectArn | Specify the Amazon Resource Name (ARN) of the project to attach the project policy to. |
Returns
Response containing PutProjectPolicy results.
StartProjectVersion
function StartProjectVersion( const ARequest: IRekognitionStartProjectVersionRequest): IRekognitionStartProjectVersionResponse; overload;
IRekognitionStartProjectVersionRequest → IRekognitionStartProjectVersionResponse
Starts the running of the version of a model.
Parameters
| Name | Description |
|---|---|
ARequest | A StartProjectVersion request object. |
Returns
Response containing StartProjectVersion results.
function StartProjectVersion(const AProjectVersionArn: TARN; const AMinInferenceUnits: Integer): IRekognitionStartProjectVersionResponse; overload;
IRekognitionStartProjectVersionResponse
Starts the running of the version of a model.
Parameters
| Name | Description |
|---|---|
AProjectVersionArn | Specify the Amazon Resource Name (ARN) of the model version that you want to start. |
AMinInferenceUnits | Specify the minimum number of inference units to use. A single inference unit represents 1 hour of processing. |
Returns
Response containing StartProjectVersion results.
function StartProjectVersion(const AProjectVersionArn: TARN; const AMinInferenceUnits, AMaxInferenceUnits: Integer): IRekognitionStartProjectVersionResponse; overload;
IRekognitionStartProjectVersionResponse
Starts the running of the version of a model.
Parameters
| Name | Description |
|---|---|
AProjectVersionArn | Specify the Amazon Resource Name (ARN) of the model version that you want to start. |
AMinInferenceUnits | Specify the minimum number of inference units to use. A single inference unit represents 1 hour of processing. |
AMaxInferenceUnits | Specify the maximum number of inference units to use for auto-scaling the model. |
Returns
Response containing StartProjectVersion results.
StopProjectVersion
function StopProjectVersion( const ARequest: IRekognitionStopProjectVersionRequest): IRekognitionStopProjectVersionResponse; overload;
IRekognitionStopProjectVersionRequest → IRekognitionStopProjectVersionResponse
Stop a running model.
Parameters
| Name | Description |
|---|---|
ARequest | A StopProjectVersion request object. |
Returns
Response containing StopProjectVersion results.
function StopProjectVersion( const AProjectVersionArn: TARN): IRekognitionStopProjectVersionResponse; overload;
IRekognitionStopProjectVersionResponse
Stop a running model.
Parameters
| Name | Description |
|---|---|
AProjectVersionArn | Specify the Amazon Resource Name (ARN) of the model version that you want to stop. |
Returns
Response containing StopProjectVersion results.
UpdateDatasetEntries
function UpdateDatasetEntries( const ARequest: IRekognitionUpdateDatasetEntriesRequest): IRekognitionUpdateDatasetEntriesResponse; overload;
IRekognitionUpdateDatasetEntriesRequest → IRekognitionUpdateDatasetEntriesResponse
Add or update one or more entries (images) in a dataset.
Parameters
| Name | Description |
|---|---|
ARequest | A UpdateDatasetEntries request object. |
Returns
Response containing UpdateDatasetEntries results.
function UpdateDatasetEntries(const ADatasetArn: TARN; const AChanges: IRekognitionDatasetChanges): IRekognitionUpdateDatasetEntriesResponse; overload;
IRekognitionDatasetChanges → IRekognitionUpdateDatasetEntriesResponse
Add or update one or more entries (images) in a dataset.
Parameters
| Name | Description |
|---|---|
ADatasetArn | Specify the Amazon Resource Name (ARN) of the dataset you want to update. |
AChanges | Specify the changes to make to the dataset. |
Returns
Response containing UpdateDatasetEntries results.
GetCelebrityRecognition
function GetCelebrityRecognition( const ARequest: IRekognitionGetCelebrityRecognitionRequest): IRekognitionGetCelebrityRecognitionResponse; overload;
IRekognitionGetCelebrityRecognitionRequest → IRekognitionGetCelebrityRecognitionResponse
Fetch the celebrity recognition results for an Amazon Rekognition Video analysis started by StartCelebrityRecognition.
Parameters
| Name | Description |
|---|---|
ARequest | A GetCelebrityRecognition request object. |
Returns
Response containing GetCelebrityRecognition results.
function GetCelebrityRecognition( const AJobId: string): IRekognitionGetCelebrityRecognitionResponse; overload;
IRekognitionGetCelebrityRecognitionResponse
Fetch the celebrity recognition results for an Amazon Rekognition Video analysis started by StartCelebrityRecognition.
Parameters
| Name | Description |
|---|---|
AJobId | Specify a job identifier for the required celebrity recognition analysis. |
Returns
Response containing GetCelebrityRecognition results.
function GetCelebrityRecognition(const AJobId: string; const AMaxResults: Integer; const ANextToken: string = ''): IRekognitionGetCelebrityRecognitionResponse; overload;
IRekognitionGetCelebrityRecognitionResponse
Fetch the celebrity recognition results for an Amazon Rekognition Video analysis started by StartCelebrityRecognition.
Parameters
| Name | Description |
|---|---|
AJobId | Specify a job identifier for the required celebrity recognition analysis. |
AMaxResults | Specify the maximum number of results to return. Valid range: 1 - 1000. |
ANextToken | Specify the NextToken from a previous response to fetch the next page of results. |
Returns
Response containing GetCelebrityRecognition results.
GetContentModeration
function GetContentModeration( const ARequest: IRekognitionGetContentModerationRequest): IRekognitionGetContentModerationResponse; overload;
IRekognitionGetContentModerationRequest → IRekognitionGetContentModerationResponse
Fetch the inappropriate, unwanted, or offensive content analysis results for an Amazon Rekognition Video analysis started by StartContentModeration.
Parameters
| Name | Description |
|---|---|
ARequest | A GetContentModeration request object. |
Returns
Response containing GetContentModeration results.
function GetContentModeration( const AJobId: string): IRekognitionGetContentModerationResponse; overload;
IRekognitionGetContentModerationResponse
Fetch the inappropriate, unwanted, or offensive content analysis results for an Amazon Rekognition Video analysis started by StartContentModeration.
Parameters
| Name | Description |
|---|---|
AJobId | Specify the identifier for the required content moderation job. |
Returns
Response containing GetContentModeration results.
function GetContentModeration(const AJobId: string; const AMaxResults: Integer; const ANextToken: string = ''): IRekognitionGetContentModerationResponse; overload;
IRekognitionGetContentModerationResponse
Fetch the inappropriate, unwanted, or offensive content analysis results for an Amazon Rekognition Video analysis started by StartContentModeration.
Parameters
| Name | Description |
|---|---|
AJobId | Specify the identifier for the required content moderation job. |
AMaxResults | Specify the maximum number of results to return. Valid range: 1 - 1000. |
ANextToken | Specify the NextToken from a previous response to fetch the next page of results. |
Returns
Response containing GetContentModeration results.
GetFaceDetection
function GetFaceDetection( const ARequest: IRekognitionGetFaceDetectionRequest): IRekognitionGetFaceDetectionResponse; overload;
IRekognitionGetFaceDetectionRequest → IRekognitionGetFaceDetectionResponse
Fetch the face detection results for an Amazon Rekognition Video analysis started by StartFaceDetection.
Parameters
| Name | Description |
|---|---|
ARequest | A GetFaceDetection request object. |
Returns
Response containing GetFaceDetection results.
function GetFaceDetection( const AJobId: string): IRekognitionGetFaceDetectionResponse; overload;
IRekognitionGetFaceDetectionResponse
Fetch the face detection results for an Amazon Rekognition Video analysis started by StartFaceDetection.
Parameters
| Name | Description |
|---|---|
AJobId | Specify the identifier for the required face detection job. |
Returns
Response containing GetFaceDetection results.
function GetFaceDetection(const AJobId: string; const AMaxResults: Integer; const ANextToken: string = ''): IRekognitionGetFaceDetectionResponse; overload;
IRekognitionGetFaceDetectionResponse
Fetch the face detection results for an Amazon Rekognition Video analysis started by StartFaceDetection.
Parameters
| Name | Description |
|---|---|
AJobId | Specify the identifier for the required face detection job. |
AMaxResults | Specify the maximum number of results to return. Valid range: 1 - 1000. |
ANextToken | Specify the NextToken from a previous response to fetch the next page of results. |
Returns
Response containing GetFaceDetection results.
GetFaceSearch
function GetFaceSearch( const ARequest: IRekognitionGetFaceSearchRequest): IRekognitionGetFaceSearchResponse; overload;
IRekognitionGetFaceSearchRequest → IRekognitionGetFaceSearchResponse
Fetch the face search results for an Amazon Rekognition Video face search started by StartFaceSearch.
Parameters
| Name | Description |
|---|---|
ARequest | A GetFaceSearch request object. |
Returns
Response containing GetFaceSearch results.
function GetFaceSearch( const AJobId: string): IRekognitionGetFaceSearchResponse; overload;
IRekognitionGetFaceSearchResponse
Fetch the face search results for an Amazon Rekognition Video face search started by StartFaceSearch.
Parameters
| Name | Description |
|---|---|
AJobId | Specify the identifier for the required face search job. |
Returns
Response containing GetFaceSearch results.
function GetFaceSearch(const AJobId: string; const AMaxResults: Integer; const ANextToken: string = ''): IRekognitionGetFaceSearchResponse; overload;
IRekognitionGetFaceSearchResponse
Fetch the face search results for an Amazon Rekognition Video face search started by StartFaceSearch.
Parameters
| Name | Description |
|---|---|
AJobId | Specify the identifier for the required face search job. |
AMaxResults | Specify the maximum number of results to return. Valid range: 1 - 1000. |
ANextToken | Specify the NextToken from a previous response to fetch the next page of results. |
Returns
Response containing GetFaceSearch results.
GetLabelDetection
function GetLabelDetection( const ARequest: IRekognitionGetLabelDetectionRequest): IRekognitionGetLabelDetectionResponse; overload;
IRekognitionGetLabelDetectionRequest → IRekognitionGetLabelDetectionResponse
Fetch the label detection results of an Amazon Rekognition Video analysis started by StartLabelDetection.
Parameters
| Name | Description |
|---|---|
ARequest | A GetLabelDetection request object. |
Returns
Response containing GetLabelDetection results.
function GetLabelDetection( const AJobId: string): IRekognitionGetLabelDetectionResponse; overload;
IRekognitionGetLabelDetectionResponse
Fetch the label detection results of an Amazon Rekognition Video analysis started by StartLabelDetection.
Parameters
| Name | Description |
|---|---|
AJobId | Specify the identifier for the required label detection job. |
Returns
Response containing GetLabelDetection results.
function GetLabelDetection(const AJobId: string; const AMaxResults: Integer; const ANextToken: string = ''): IRekognitionGetLabelDetectionResponse; overload;
IRekognitionGetLabelDetectionResponse
Fetch the label detection results of an Amazon Rekognition Video analysis started by StartLabelDetection.
Parameters
| Name | Description |
|---|---|
AJobId | Specify the identifier for the required label detection job. |
AMaxResults | Specify the maximum number of results to return. Valid range: 1 - 1000. |
ANextToken | Specify the NextToken from a previous response to fetch the next page of results. |
Returns
Response containing GetLabelDetection results.
GetSegmentDetection
function GetSegmentDetection( const ARequest: IRekognitionGetSegmentDetectionRequest): IRekognitionGetSegmentDetectionResponse; overload;
IRekognitionGetSegmentDetectionRequest → IRekognitionGetSegmentDetectionResponse
Fetch the segment detection results of an Amazon Rekognition Video analysis started by StartSegmentDetection.
Parameters
| Name | Description |
|---|---|
ARequest | A GetSegmentDetection request object. |
Returns
Response containing GetSegmentDetection results.
function GetSegmentDetection( const AJobId: string): IRekognitionGetSegmentDetectionResponse; overload;
IRekognitionGetSegmentDetectionResponse
Fetch the segment detection results of an Amazon Rekognition Video analysis started by StartSegmentDetection.
Parameters
| Name | Description |
|---|---|
AJobId | Specify the identifier for the required segment detection job. |
Returns
Response containing GetSegmentDetection results.
function GetSegmentDetection(const AJobId: string; const AMaxResults: Integer; const ANextToken: string = ''): IRekognitionGetSegmentDetectionResponse; overload;
IRekognitionGetSegmentDetectionResponse
Fetch the segment detection results of an Amazon Rekognition Video analysis started by StartSegmentDetection.
Parameters
| Name | Description |
|---|---|
AJobId | Specify the identifier for the required segment detection job. |
AMaxResults | Specify the maximum number of results to return. Valid range: 1 - 1000. |
ANextToken | Specify the NextToken from a previous response to fetch the next page of results. |
Returns
Response containing GetSegmentDetection results.
GetTextDetection
function GetTextDetection( const ARequest: IRekognitionGetTextDetectionRequest): IRekognitionGetTextDetectionResponse; overload;
IRekognitionGetTextDetectionRequest → IRekognitionGetTextDetectionResponse
Fetch the text detection results of an Amazon Rekognition Video analysis started by StartTextDetection.
Parameters
| Name | Description |
|---|---|
ARequest | A GetTextDetection request object. |
Returns
Response containing GetTextDetection results.
function GetTextDetection( const AJobId: string): IRekognitionGetTextDetectionResponse; overload;
IRekognitionGetTextDetectionResponse
Fetch the text detection results of an Amazon Rekognition Video analysis started by StartTextDetection.
Parameters
| Name | Description |
|---|---|
AJobId | Specify the identifier for the required text detection job. |
Returns
Response containing GetTextDetection results.
function GetTextDetection(const AJobId: string; const AMaxResults: Integer; const ANextToken: string = ''): IRekognitionGetTextDetectionResponse; overload;
IRekognitionGetTextDetectionResponse
Fetch the text detection results of an Amazon Rekognition Video analysis started by StartTextDetection.
Parameters
| Name | Description |
|---|---|
AJobId | Specify the identifier for the required text detection job. |
AMaxResults | Specify the maximum number of results to return. Valid range: 1 - 1000. |
ANextToken | Specify the NextToken from a previous response to fetch the next page of results. |
Returns
Response containing GetTextDetection results.
StartCelebrityRecognition
function StartCelebrityRecognition( const ARequest: IRekognitionStartCelebrityRecognitionRequest): IRekognitionStartCelebrityRecognitionResponse; overload;
IRekognitionStartCelebrityRecognitionRequest → IRekognitionStartCelebrityRecognitionResponse
Start an asynchronous job to recognize celebrities in a stored video.
Parameters
| Name | Description |
|---|---|
ARequest | A StartCelebrityRecognition request object. |
Returns
Response containing StartCelebrityRecognition results.
function StartCelebrityRecognition( const AVideo: IRekognitionVideo): IRekognitionStartCelebrityRecognitionResponse; overload;
IRekognitionVideo → IRekognitionStartCelebrityRecognitionResponse
Start an asynchronous job to recognize celebrities in a stored video.
Parameters
| Name | Description |
|---|---|
AVideo | Specify a video stored on Amazon S3 to recognize celebrities in. |
Returns
Response containing StartCelebrityRecognition results.
function StartCelebrityRecognition(const AVideo: IRekognitionVideo; const AJobTag: string; const ANotificationChannel: IRekognitionNotificationChannel): IRekognitionStartCelebrityRecognitionResponse; overload;
IRekognitionVideo, IRekognitionNotificationChannel → IRekognitionStartCelebrityRecognitionResponse
Start an asynchronous job to recognize celebrities in a stored video.
Parameters
| Name | Description |
|---|---|
AVideo | Specify a video stored on Amazon S3 to recognize celebrities in. |
AJobTag | Specify an identifier that's returned in completion notification that's published to a Amazon Simple Notification Service topic. |
ANotificationChannel | Specify the Amazon Simple Notification Service (SNS) topic that you want Amazon Rekognition to publish a completion notification to. |
Returns
Response containing StartCelebrityRecognition results.
StartContentModeration
function StartContentModeration( const ARequest: IRekognitionStartContentModerationRequest): IRekognitionStartContentModerationResponse; overload;
IRekognitionStartContentModerationRequest → IRekognitionStartContentModerationResponse
Start an asynchronous job to detect inappropriate, unwanted, or offensive content in a stored video.
Parameters
| Name | Description |
|---|---|
ARequest | A StartContentModeration request object. |
Returns
Response containing StartContentModeration results.
function StartContentModeration( const AVideo: IRekognitionVideo): IRekognitionStartContentModerationResponse; overload;
IRekognitionVideo → IRekognitionStartContentModerationResponse
Start an asynchronous job to detect inappropriate, unwanted, or offensive content in a stored video.
Parameters
| Name | Description |
|---|---|
AVideo | Specify a video stored on Amazon S3 to detect inappropriate, unwanted, or offensive content in. |
Returns
Response containing StartContentModeration results.
function StartContentModeration(const AVideo: IRekognitionVideo; const AJobTag: string; const ANotificationChannel: IRekognitionNotificationChannel): IRekognitionStartContentModerationResponse; overload;
IRekognitionVideo, IRekognitionNotificationChannel → IRekognitionStartContentModerationResponse
Start an asynchronous job to detect inappropriate, unwanted, or offensive content in a stored video.
Parameters
| Name | Description |
|---|---|
AVideo | Specify a video stored on Amazon S3 to detect inappropriate, unwanted, or offensive content in. |
AJobTag | Specify an identifier that's returned in completion notification that's published to a Amazon Simple Notification Service topic. |
ANotificationChannel | Specify the Amazon Simple Notification Service (SNS) topic that you want Amazon Rekognition to publish a completion notification to. |
Returns
Response containing StartContentModeration results.
StartFaceDetection
function StartFaceDetection( const ARequest: IRekognitionStartFaceDetectionRequest): IRekognitionStartFaceDetectionResponse; overload;
IRekognitionStartFaceDetectionRequest → IRekognitionStartFaceDetectionResponse
Start an asynchronous job to detect faces in a stored video.
Parameters
| Name | Description |
|---|---|
ARequest | A StartFaceDetection request object. |
Returns
Response containing StartFaceDetection results.
function StartFaceDetection( const AVideo: IRekognitionVideo): IRekognitionStartFaceDetectionResponse; overload;
IRekognitionVideo → IRekognitionStartFaceDetectionResponse
Start an asynchronous job to detect faces in a stored video.
Parameters
| Name | Description |
|---|---|
AVideo | Specify a video stored on Amazon S3 to detect faces in. |
Returns
Response containing StartFaceDetection results.
function StartFaceDetection(const AVideo: IRekognitionVideo; const AJobTag: string; const ANotificationChannel: IRekognitionNotificationChannel): IRekognitionStartFaceDetectionResponse; overload;
IRekognitionVideo, IRekognitionNotificationChannel → IRekognitionStartFaceDetectionResponse
Start an asynchronous job to detect faces in a stored video.
Parameters
| Name | Description |
|---|---|
AVideo | Specify a video stored on Amazon S3 to detect faces in. |
AJobTag | Specify an identifier that's returned in completion notification that's published to a Amazon Simple Notification Service topic. |
ANotificationChannel | Specify the Amazon Simple Notification Service (SNS) topic that you want Amazon Rekognition to publish a completion notification to. |
Returns
Response containing StartFaceDetection results.
StartFaceSearch
function StartFaceSearch( const ARequest: IRekognitionStartFaceSearchRequest): IRekognitionStartFaceSearchResponse; overload;
IRekognitionStartFaceSearchRequest → IRekognitionStartFaceSearchResponse
Start an asynchronous job to search for faces in a collection that match the faces of persons detected in a stored video.
Parameters
| Name | Description |
|---|---|
ARequest | A StartFaceSearch request object. |
Returns
Response containing StartFaceSearch results.
function StartFaceSearch(const ACollectionId: string; const AVideo: IRekognitionVideo): IRekognitionStartFaceSearchResponse; overload;
IRekognitionVideo → IRekognitionStartFaceSearchResponse
Start an asynchronous job to search for faces in a collection that match the faces of persons detected in a stored video.
Parameters
| Name | Description |
|---|---|
ACollectionId | Specify the ID of a collection containing the faces you want to search for. |
AVideo | Specify a video stored on Amazon S3 to detect search for faces in. |
Returns
Response containing StartFaceSearch results.
function StartFaceSearch(const ACollectionId: string; const AVideo: IRekognitionVideo; const AJobTag: string; const ANotificationChannel: IRekognitionNotificationChannel): IRekognitionStartFaceSearchResponse; overload;
IRekognitionVideo, IRekognitionNotificationChannel → IRekognitionStartFaceSearchResponse
Start an asynchronous job to search for faces in a collection that match the faces of persons detected in a stored video.
Parameters
| Name | Description |
|---|---|
ACollectionId | Specify the ID of a collection containing the faces you want to search for. |
AVideo | Specify a video stored on Amazon S3 to detect search for faces in. |
AJobTag | Specify an identifier that's returned in completion notification that's published to a Amazon Simple Notification Service topic. |
ANotificationChannel | Specify the Amazon Simple Notification Service (SNS) topic that you want Amazon Rekognition to publish a completion notification to. |
Returns
Response containing StartFaceSearch results.
StartLabelDetection
function StartLabelDetection( const ARequest: IRekognitionStartLabelDetectionRequest): IRekognitionStartLabelDetectionResponse; overload;
IRekognitionStartLabelDetectionRequest → IRekognitionStartLabelDetectionResponse
Start an asynchronous job to detect labels in a stored video.
Parameters
| Name | Description |
|---|---|
ARequest | A StartLabelDetection request object. |
Returns
Response containing StartLabelDetection results.
function StartLabelDetection( const AVideo: IRekognitionVideo): IRekognitionStartLabelDetectionResponse; overload;
IRekognitionVideo → IRekognitionStartLabelDetectionResponse
Start an asynchronous job to detect labels in a stored video.
Parameters
| Name | Description |
|---|---|
AVideo | Specify a video stored on Amazon S3 to detect labels in. |
Returns
Response containing StartLabelDetection results.
function StartLabelDetection(const AVideo: IRekognitionVideo; const AJobTag: string; const ANotificationChannel: IRekognitionNotificationChannel): IRekognitionStartLabelDetectionResponse; overload;
IRekognitionVideo, IRekognitionNotificationChannel → IRekognitionStartLabelDetectionResponse
Start an asynchronous job to detect labels in a stored video.
Parameters
| Name | Description |
|---|---|
AVideo | Specify a video stored on Amazon S3 to detect labels in. |
AJobTag | Specify an identifier that's returned in completion notification that's published to a Amazon Simple Notification Service topic. |
ANotificationChannel | Specify the Amazon Simple Notification Service (SNS) topic that you want Amazon Rekognition to publish a completion notification to. |
Returns
Response containing StartLabelDetection results.
StartSegmentDetection
function StartSegmentDetection( const ARequest: IRekognitionStartSegmentDetectionRequest): IRekognitionStartSegmentDetectionResponse; overload;
IRekognitionStartSegmentDetectionRequest → IRekognitionStartSegmentDetectionResponse
Start an asynchronous job to detect segments in a stored video.
Parameters
| Name | Description |
|---|---|
ARequest | A StartSegmentDetection request object. |
Returns
Response containing StartSegmentDetection results.
function StartSegmentDetection(const ASegmentTypes: array of string; const AVideo: IRekognitionVideo): IRekognitionStartSegmentDetectionResponse; overload;
IRekognitionVideo → IRekognitionStartSegmentDetectionResponse
Start an asynchronous job to detect segments in a stored video.
Parameters
| Name | Description |
|---|---|
ASegmentTypes | Specify a list of segment types to detect in the video. Valid values:|. |
AVideo | Specify a video stored on Amazon S3 to detect segments in. |
Returns
Response containing StartSegmentDetection results.
function StartSegmentDetection(const ASegmentTypes: array of string; const AVideo: IRekognitionVideo; const AJobTag: string; const ANotificationChannel: IRekognitionNotificationChannel): IRekognitionStartSegmentDetectionResponse; overload;
IRekognitionVideo, IRekognitionNotificationChannel → IRekognitionStartSegmentDetectionResponse
Start an asynchronous job to detect segments in a stored video.
Parameters
| Name | Description |
|---|---|
ASegmentTypes | Specify a list of segment types to detect in the video. Valid values:|. |
AVideo | Specify a video stored on Amazon S3 to detect segments in. |
AJobTag | Specify an identifier that's returned in completion notification that's published to a Amazon Simple Notification Service topic. |
ANotificationChannel | Specify the Amazon Simple Notification Service (SNS) topic that you want Amazon Rekognition to publish a completion notification to. |
Returns
Response containing StartSegmentDetection results.
StartTextDetection
function StartTextDetection( const ARequest: IRekognitionStartTextDetectionRequest): IRekognitionStartTextDetectionResponse; overload;
IRekognitionStartTextDetectionRequest → IRekognitionStartTextDetectionResponse
Start an asynchronous job to detect text in a stored video.
Parameters
| Name | Description |
|---|---|
ARequest | A StartTextDetection request object. |
Returns
Response containing StartTextDetection results.
function StartTextDetection( const AVideo: IRekognitionVideo): IRekognitionStartTextDetectionResponse; overload;
IRekognitionVideo → IRekognitionStartTextDetectionResponse
Start an asynchronous job to detect text in a stored video.
Parameters
| Name | Description |
|---|---|
AVideo | Specify a video stored on Amazon S3 to detect text in. |
Returns
Response containing StartTextDetection results.
function StartTextDetection(const AVideo: IRekognitionVideo; const AJobTag: string; const ANotificationChannel: IRekognitionNotificationChannel): IRekognitionStartTextDetectionResponse; overload;
IRekognitionVideo, IRekognitionNotificationChannel → IRekognitionStartTextDetectionResponse
Start an asynchronous job to detect text in a stored video.
Parameters
| Name | Description |
|---|---|
AVideo | Specify a video stored on Amazon S3 to detect text in. |
AJobTag | Specify an identifier that's returned in completion notification that's published to a Amazon Simple Notification Service topic. |
ANotificationChannel | Specify the Amazon Simple Notification Service (SNS) topic that you want Amazon Rekognition to publish a completion notification to. |
Returns
Response containing StartTextDetection results.
ListTagsForResource
function ListTagsForResource( const ARequest: IRekognitionListTagsForResourceRequest): IRekognitionListTagsForResourceResponse; overload;
IRekognitionListTagsForResourceRequest → IRekognitionListTagsForResourceResponse
Fetch a list of tags in an Amazon Rekognition collection, stream processor, or Custom Labels model.
Parameters
| Name | Description |
|---|---|
ARequest | A ListTagsForResource request object. |
Returns
Response containing ListTagsForResource results.
function ListTagsForResource( const AResourceArn: TARN): IRekognitionListTagsForResourceResponse; overload;
IRekognitionListTagsForResourceResponse
Fetch a list of tags in an Amazon Rekognition collection, stream processor, or Custom Labels model.
Parameters
| Name | Description |
|---|---|
AResourceArn | Specify the Amazon Resource Name (ARN) of the collaction, stream processor, or custom model containing the tags you want to list. |
Returns
Response containing ListTagsForResource results.
TagResource
function TagResource( const ARequest: IRekognitionTagResourceRequest): IRekognitionTagResourceResponse; overload;
IRekognitionTagResourceRequest → IRekognitionTagResourceResponse
Add one or more key/value tags to an Amazon Rekognition collection, stream processor, or Custom Labels model.
Parameters
| Name | Description |
|---|---|
ARequest | A TagResource request object. |
Returns
Response containing TagResource results.
function TagResource(const AResourceArn: TARN; const ATags: array of TRekognitionTagKeyValue): IRekognitionTagResourceResponse; overload;
IRekognitionTagResourceResponse
Add one or more key/value tags to an Amazon Rekognition collection, stream processor, or Custom Labels model.
Parameters
| Name | Description |
|---|---|
AReourceArn | Specify the Amazon Resource Name (ARN) of the collaction, stream processor, or custom model to add tags to. |
ATags | Specify a list of key/value tags to add to the resource. |
Returns
Response containing TagResource results.
UntagResource
function UntagResource( const ARequest: IRekognitionUntagResourceRequest): IRekognitionUntagResourceResponse; overload;
IRekognitionUntagResourceRequest → IRekognitionUntagResourceResponse
Remove one or more tags from an Amazon Rekognition collection, stream processor, or Custom Labels model.
Parameters
| Name | Description |
|---|---|
ARequest | A UntagResource request object. |
Returns
Response containing UntagResource results.
function UntagResource(const AResourceArn: TARN; const ATagKeys: array of string): IRekognitionUntagResourceResponse; overload;
IRekognitionUntagResourceResponse
Remove one or more tags from an Amazon Rekognition collection, stream processor, or Custom Labels model.
Parameters
| Name | Description |
|---|---|
AReourceArn | Specify the Amazon Resource Name (ARN) of the collaction, stream processor, or custom model to remove tags from. |
ATagKeys | Specify a list of tag keys to remove from the resource. |
Returns
Response containing UntagResource results.