From 0fd00b9cda788fd459184e92e57ee25d3c816dcc Mon Sep 17 00:00:00 2001 From: aws-sdk-go-automation <43143561+aws-sdk-go-automation@users.noreply.github.com> Date: Tue, 6 Sep 2022 11:24:44 -0700 Subject: [PATCH] Release v1.44.92 (2022-09-06) (#4548) Release v1.44.92 (2022-09-06) === ### Service Client Updates * `service/identitystore`: Updates service documentation * `service/sagemaker`: Updates service API and documentation * This release adds HyperParameterTuningJob type in Search API. --- CHANGELOG.md | 8 + aws/version.go | 2 +- .../apis/identitystore/2020-06-15/docs-2.json | 66 +++--- models/apis/sagemaker/2017-07-24/api-2.json | 27 ++- models/apis/sagemaker/2017-07-24/docs-2.json | 32 ++- service/identitystore/api.go | 99 +++++---- service/identitystore/doc.go | 15 +- service/sagemaker/api.go | 200 ++++++++++++++++++ 8 files changed, 354 insertions(+), 95 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 2aa228c3ec7..dceec5ddcfa 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,11 @@ +Release v1.44.92 (2022-09-06) +=== + +### Service Client Updates +* `service/identitystore`: Updates service documentation +* `service/sagemaker`: Updates service API and documentation + * This release adds HyperParameterTuningJob type in Search API. + Release v1.44.91 (2022-09-02) === diff --git a/aws/version.go b/aws/version.go index f09b245b04e..e2cd970971a 100644 --- a/aws/version.go +++ b/aws/version.go @@ -5,4 +5,4 @@ package aws const SDKName = "aws-sdk-go" // SDKVersion is the version of this SDK -const SDKVersion = "1.44.91" +const SDKVersion = "1.44.92" diff --git a/models/apis/identitystore/2020-06-15/docs-2.json b/models/apis/identitystore/2020-06-15/docs-2.json index c48707cf3a3..65d427b547e 100644 --- a/models/apis/identitystore/2020-06-15/docs-2.json +++ b/models/apis/identitystore/2020-06-15/docs-2.json @@ -1,6 +1,6 @@ { "version": "2.0", - "service": "

The AWS Single Sign-On (SSO) Identity Store service provides a single place to retrieve all of your identities (users and groups). For more information about AWS, see the AWS Single Sign-On User Guide.

", + "service": "

The Identity Store service used by AWS IAM Identity Center (successor to AWS Single Sign-On) provides a single place to retrieve all of your identities (users and groups). For more information, see the IAM Identity Center User Guide.

 <note> <p>Although AWS Single Sign-On was renamed, the <code>sso</code> and <code>identitystore</code> API namespaces will continue to retain their original name for backward compatibility purposes. For more information, see <a href="https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html#renamed">IAM Identity Center rename</a>.</p> </note> <p>This reference guide describes the identity store operations that you can call programatically and includes detailed information on data types and errors.</p> 
", "operations": { "CreateGroup": "

Creates a group within the specified identity store.

", "CreateGroupMembership": "

Creates a relationship between a member and a group. The following identifiers must be specified: GroupId, IdentityStoreId, and MemberId.

", @@ -9,16 +9,16 @@ "DeleteGroupMembership": "

Delete a membership within a group given MembershipId.

", "DeleteUser": "

Deletes a user within an identity store given UserId.

", "DescribeGroup": "

Retrieves the group metadata and attributes from GroupId in an identity store.

", - "DescribeGroupMembership": "

Retrieves membership metadata and attributes from MembershipId in a group.

", + "DescribeGroupMembership": "

Retrieves membership metadata and attributes from MembershipId in an identity store.

", "DescribeUser": "

Retrieves the user metadata and attributes from the UserId in an identity store.

", "GetGroupId": "

Retrieves GroupId in an identity store.

", - "GetGroupMembershipId": "

Retrieves the MembershipId in a group.

", + "GetGroupMembershipId": "

Retrieves the MembershipId in an identity store.

", "GetUserId": "

Retrieves the UserId in an identity store.

", - "IsMemberInGroups": "

Returns if a member exists in specified groups.

", + "IsMemberInGroups": "

Checks the user's membership in all requested groups and returns if the member exists in all queried groups.

", "ListGroupMemberships": "

For the specified group in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.

", "ListGroupMembershipsForMember": "

For the specified member in the specified identity store, returns the list of all GroupMembership objects and returns results in paginated form.

", - "ListGroups": "

Filtering for a group by the group DisplayName attribute is deprecated. Instead, use the GetGroupId API action.

Lists all groups in the identity store. Returns a paginated list of complete Group objects.

", - "ListUsers": "

Filtering for a user by the UserName attribute is deprecated. Instead, use the GetUserId API action.

Lists all users in the identity store. Returns a paginated list of complete User objects.

", + "ListGroups": "

Lists the attribute name and value of the group that you specified in the search. We only support DisplayName as a valid filter attribute path currently, and filter is required. This API returns minimum attributes, including GroupId and group DisplayName in the response.

", + "ListUsers": "

Lists the attribute name and value of the user that you specified in the search. We only support UserName as a valid filter attribute path currently, and filter is required. This API returns minimum attributes, including UserId and UserName in the response.

", "UpdateGroup": "

For the specified group in the specified identity store, updates the group metadata and attributes.

", "UpdateUser": "

For the specified user in the specified identity store, updates the user metadata and attributes.

" }, @@ -43,10 +43,10 @@ } }, "AlternateIdentifier": { - "base": "

A unique identifier for the group value that is not the group's primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the group or a unique attribute. For example, a unique GroupDisplayName.

", + "base": "

A unique identifier for a user or group that is not the its primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the group or a unique attribute. For example, a unique GroupDisplayName.

", "refs": { - "GetGroupIdRequest$AlternateIdentifier": "

A unique identifier for the group value that is not the group's primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the group or a unique attribute. For example, a unique GroupDisplayName.

", - "GetUserIdRequest$AlternateIdentifier": "

Any unique attribute associated with a user that is not the UserId.

" + "GetGroupIdRequest$AlternateIdentifier": "

A unique identifier for an identity resource that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the group or a unique attribute. For example, a unique GroupDisplayName.

", + "GetUserIdRequest$AlternateIdentifier": "

A unique identifier for an identity resource that is not the primary identifier.

" } }, "AttributeOperation": { @@ -71,10 +71,10 @@ } }, "AttributeValue": { - "base": "

The value of the attribute.

", + "base": "

The value of the attribute. This is a Document type. This type is not supported by Java V1, Go V1, and older versions of the AWS CLI.

", "refs": { - "AttributeOperation$AttributeValue": "

The value of the attribute.

", - "UniqueAttribute$AttributeValue": "

The value of the attribute.

" + "AttributeOperation$AttributeValue": "

The value of the attribute. This is a Document type. This type is not supported by Java V1, Go V1, and older versions of the AWS CLI.

", + "UniqueAttribute$AttributeValue": "

The value of the attribute. This is a Document type. This type is not supported by Java V1, Go V1, and older versions of the AWS CLI.

" } }, "ConflictException": { @@ -241,8 +241,8 @@ "Filters": { "base": null, "refs": { - "ListGroupsRequest$Filters": "

A list of Filter objects that is used in the ListUsers and ListGroups requests.

", - "ListUsersRequest$Filters": "

A list of Filter objects that is used in the ListUsers and ListGroups requests.

" + "ListGroupsRequest$Filters": "

A list of Filter objects, which is used in the ListUsers and ListGroups requests.

", + "ListUsersRequest$Filters": "

A list of Filter objects, which is used in the ListUsers and ListGroups requests.

" } }, "GetGroupIdRequest": { @@ -310,7 +310,7 @@ "GroupMembershipExistenceResults": { "base": null, "refs": { - "IsMemberInGroupsResponse$Results": "

An object containing results of batch IsMemberInGroups call.

" + "IsMemberInGroupsResponse$Results": "

A list containing the results of membership existence checks.

" } }, "GroupMemberships": { @@ -421,7 +421,7 @@ "base": null, "refs": { "ListGroupMembershipsForMemberRequest$MaxResults": "

The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

", - "ListGroupMembershipsRequest$MaxResults": "

The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

", + "ListGroupMembershipsRequest$MaxResults": "

The maximum number of results to be returned per request. This parameter is used in all List requests to specify how many results to return in one page.

", "ListGroupsRequest$MaxResults": "

The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

", "ListUsersRequest$MaxResults": "

The maximum number of results to be returned per request. This parameter is used in the ListUsers and ListGroups requests to specify how many results to return in one page. The length limit is 50 characters.

" } @@ -439,7 +439,7 @@ } }, "Name": { - "base": "

The name of the user.

", + "base": "

The full name of the user.

", "refs": { "CreateUserRequest$Name": "

An object containing the user's name.

", "DescribeUserResponse$Name": "

The name of the user.

", @@ -449,10 +449,10 @@ "NextToken": { "base": null, "refs": { - "ListGroupMembershipsForMemberRequest$NextToken": "

The pagination token used for the ListUsers, ListGroups and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

", - "ListGroupMembershipsForMemberResponse$NextToken": "

The pagination token used for the ListUsers, ListGroups and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

", + "ListGroupMembershipsForMemberRequest$NextToken": "

The pagination token used for the ListUsers, ListGroups, and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

", + "ListGroupMembershipsForMemberResponse$NextToken": "

The pagination token used for the ListUsers, ListGroups, and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

", "ListGroupMembershipsRequest$NextToken": "

The pagination token used for the ListUsers, ListGroups and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

", - "ListGroupMembershipsResponse$NextToken": "

The pagination token used for the ListUsers, ListGroups and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

", + "ListGroupMembershipsResponse$NextToken": "

The pagination token used for the ListUsers, ListGroups, and ListGroupMemberships API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

", "ListGroupsRequest$NextToken": "

The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

", "ListGroupsResponse$NextToken": "

The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it1 is used in the API request to search for the next page.

", "ListUsersRequest$NextToken": "

The pagination token used for the ListUsers and ListGroups API operations. This value is generated by the identity store service. It is returned in the API response if the total results are more than the size of one page. This token is also returned when it is used in the API request to search for the next page.

", @@ -489,14 +489,14 @@ "base": null, "refs": { "CreateGroupMembershipRequest$GroupId": "

The identifier for a group in the identity store.

", - "CreateGroupMembershipResponse$MembershipId": "

The identifier for a GroupMembership in the identity store.

", + "CreateGroupMembershipResponse$MembershipId": "

The identifier for a newly created GroupMembership in an identity store.

", "CreateGroupResponse$GroupId": "

The identifier of the newly created group in the identity store.

", "CreateUserResponse$UserId": "

The identifier of the newly created user in the identity store.

", - "DeleteGroupMembershipRequest$MembershipId": "

The identifier for a GroupMembership in the identity store.

", + "DeleteGroupMembershipRequest$MembershipId": "

The identifier for a GroupMembership in an identity store.

", "DeleteGroupRequest$GroupId": "

The identifier for a group in the identity store.

", "DeleteUserRequest$UserId": "

The identifier for a user in the identity store.

", - "DescribeGroupMembershipRequest$MembershipId": "

The identifier for a GroupMembership in the identity store.

", - "DescribeGroupMembershipResponse$MembershipId": "

The identifier for a GroupMembership in the identity store.

", + "DescribeGroupMembershipRequest$MembershipId": "

The identifier for a GroupMembership in an identity store.

", + "DescribeGroupMembershipResponse$MembershipId": "

The identifier for a GroupMembership in an identity store.

", "DescribeGroupMembershipResponse$GroupId": "

The identifier for a group in the identity store.

", "DescribeGroupRequest$GroupId": "

The identifier for a group in the identity store.

", "DescribeGroupResponse$GroupId": "

The identifier for a group in the identity store.

", @@ -504,11 +504,11 @@ "DescribeUserResponse$UserId": "

The identifier for a user in the identity store.

", "GetGroupIdResponse$GroupId": "

The identifier for a group in the identity store.

", "GetGroupMembershipIdRequest$GroupId": "

The identifier for a group in the identity store.

", - "GetGroupMembershipIdResponse$MembershipId": "

The identifier for a GroupMembership in the identity store.

", + "GetGroupMembershipIdResponse$MembershipId": "

The identifier for a GroupMembership in an identity store.

", "GetUserIdResponse$UserId": "

The identifier for a user in the identity store.

", "Group$GroupId": "

The identifier for a group in the identity store.

", "GroupIds$member": null, - "GroupMembership$MembershipId": "

The identifier for a GroupMembership object in the identity store.

", + "GroupMembership$MembershipId": "

The identifier for a GroupMembership object in an identity store.

", "GroupMembership$GroupId": "

The identifier for a group in the identity store.

", "GroupMembershipExistenceResult$GroupId": "

The identifier for a group in the identity store.

", "ListGroupMembershipsRequest$GroupId": "

The identifier for a group in the identity store.

", @@ -540,10 +540,10 @@ "SensitiveBooleanType": { "base": null, "refs": { - "Address$Primary": "

A boolean representing whether this is the primary address for the associated resource.

", - "Email$Primary": "

A boolean representing whether this is the primary email for the associated resource.

", + "Address$Primary": "

A Boolean value representing whether this is the primary address for the associated resource.

", + "Email$Primary": "

A Boolean value representing whether this is the primary email address for the associated resource.

", "GroupMembershipExistenceResult$MembershipExists": "

Indicates whether a membership relation exists or not.

", - "PhoneNumber$Primary": "

A boolean representing whether this is the primary phone number for the associated resource.

" + "PhoneNumber$Primary": "

A Boolean value representing whether this is the primary phone number for the associated resource.

" } }, "SensitiveStringType": { @@ -590,7 +590,7 @@ "User$NickName": "

A string containing an alternate name for the user.

", "User$ProfileUrl": "

A string containing a URL that may be associated with the user.

", "User$UserType": "

A string indicating the user's type. Possible values depend on each customer's specific needs, so they are left unspecified.

", - "User$Title": "

A string containing the user's title. Possible values depend on each customer's specific needs, so they are left unspecified

", + "User$Title": "

A string containing the user's title. Possible values depend on each customer's specific needs, so they are left unspecified.

", "User$PreferredLanguage": "

A string containing the preferred language of the user. For example, \"American English\" or \"en-us.\"

", "User$Locale": "

A string containing the user's geographical region or location.

", "User$Timezone": "

A string containing the user's time zone.

" @@ -641,9 +641,9 @@ "UserName": { "base": null, "refs": { - "CreateUserRequest$UserName": "

A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. The characters <>;:% are excluded. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.

", - "DescribeUserResponse$UserName": "

The user’s username value. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. The characters <>;:% are excluded. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.

", - "User$UserName": "

The user’s user name value. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. The characters <>;:% are excluded. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.

" + "CreateUserRequest$UserName": "

A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.

", + "DescribeUserResponse$UserName": "

A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.

", + "User$UserName": "

A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.

" } }, "Users": { diff --git a/models/apis/sagemaker/2017-07-24/api-2.json b/models/apis/sagemaker/2017-07-24/api-2.json index f577aaa7613..9c4cf848fee 100644 --- a/models/apis/sagemaker/2017-07-24/api-2.json +++ b/models/apis/sagemaker/2017-07-24/api-2.json @@ -9717,6 +9717,27 @@ "type":"list", "member":{"shape":"HyperParameterTuningJobObjective"} }, + "HyperParameterTuningJobSearchEntity":{ + "type":"structure", + "members":{ + "HyperParameterTuningJobName":{"shape":"HyperParameterTuningJobName"}, + "HyperParameterTuningJobArn":{"shape":"HyperParameterTuningJobArn"}, + "HyperParameterTuningJobConfig":{"shape":"HyperParameterTuningJobConfig"}, + "TrainingJobDefinition":{"shape":"HyperParameterTrainingJobDefinition"}, + "TrainingJobDefinitions":{"shape":"HyperParameterTrainingJobDefinitions"}, + "HyperParameterTuningJobStatus":{"shape":"HyperParameterTuningJobStatus"}, + "CreationTime":{"shape":"Timestamp"}, + "HyperParameterTuningEndTime":{"shape":"Timestamp"}, + "LastModifiedTime":{"shape":"Timestamp"}, + "TrainingJobStatusCounters":{"shape":"TrainingJobStatusCounters"}, + "ObjectiveStatusCounters":{"shape":"ObjectiveStatusCounters"}, + "BestTrainingJob":{"shape":"HyperParameterTrainingJobSummary"}, + "OverallBestTrainingJob":{"shape":"HyperParameterTrainingJobSummary"}, + "WarmStartConfig":{"shape":"HyperParameterTuningJobWarmStartConfig"}, + "FailureReason":{"shape":"FailureReason"}, + "Tags":{"shape":"TagList"} + } + }, "HyperParameterTuningJobSortByOptions":{ "type":"string", "enum":[ @@ -15001,7 +15022,8 @@ "PipelineExecution", "FeatureGroup", "Project", - "FeatureMetadata" + "FeatureMetadata", + "HyperParameterTuningJob" ] }, "ResponseMIMEType":{ @@ -15196,7 +15218,8 @@ "PipelineExecution":{"shape":"PipelineExecution"}, "FeatureGroup":{"shape":"FeatureGroup"}, "Project":{"shape":"Project"}, - "FeatureMetadata":{"shape":"FeatureMetadata"} + "FeatureMetadata":{"shape":"FeatureMetadata"}, + "HyperParameterTuningJob":{"shape":"HyperParameterTuningJobSearchEntity"} } }, "SearchRequest":{ diff --git a/models/apis/sagemaker/2017-07-24/docs-2.json b/models/apis/sagemaker/2017-07-24/docs-2.json index fe93228bb8e..1752ba95bdf 100644 --- a/models/apis/sagemaker/2017-07-24/docs-2.json +++ b/models/apis/sagemaker/2017-07-24/docs-2.json @@ -4487,6 +4487,7 @@ "FeatureGroup$FailureReason": "

The reason that the FeatureGroup failed to be replicated in the OfflineStore. This is failure may be due to a failure to create a FeatureGroup in or delete a FeatureGroup from the OfflineStore.

", "FlowDefinitionSummary$FailureReason": "

The reason why the flow definition creation failed. A failure reason is returned only when the flow definition status is Failed.

", "HyperParameterTrainingJobSummary$FailureReason": "

The reason that the training job failed.

", + "HyperParameterTuningJobSearchEntity$FailureReason": "

The error that was created when a hyperparameter tuning job failed.

", "Image$FailureReason": "

When a create, update, or delete operation fails, the reason for the failure.

", "ImageVersion$FailureReason": "

When a create or delete operation fails, the reason for the failure.

", "InferenceRecommendationsJob$FailureReason": "

If the job fails, provides information why the job failed.

", @@ -5076,7 +5077,8 @@ "refs": { "CreateHyperParameterTuningJobRequest$TrainingJobDefinition": "

The HyperParameterTrainingJobDefinition object that describes the training jobs that this tuning job launches, including static hyperparameters, input data configuration, output data configuration, resource configuration, and stopping condition.

", "DescribeHyperParameterTuningJobResponse$TrainingJobDefinition": "

The HyperParameterTrainingJobDefinition object that specifies the definition of the training jobs that this tuning job launches.

", - "HyperParameterTrainingJobDefinitions$member": null + "HyperParameterTrainingJobDefinitions$member": null, + "HyperParameterTuningJobSearchEntity$TrainingJobDefinition": null } }, "HyperParameterTrainingJobDefinitionName": { @@ -5090,7 +5092,8 @@ "base": null, "refs": { "CreateHyperParameterTuningJobRequest$TrainingJobDefinitions": "

A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.

", - "DescribeHyperParameterTuningJobResponse$TrainingJobDefinitions": "

A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.

" + "DescribeHyperParameterTuningJobResponse$TrainingJobDefinitions": "

A list of the HyperParameterTrainingJobDefinition objects launched for this tuning job.

", + "HyperParameterTuningJobSearchEntity$TrainingJobDefinitions": "

The job definitions included in a hyperparameter tuning job.

" } }, "HyperParameterTrainingJobSummaries": { @@ -5104,7 +5107,9 @@ "refs": { "DescribeHyperParameterTuningJobResponse$BestTrainingJob": "

A TrainingJobSummary object that describes the training job that completed with the best current HyperParameterTuningJobObjective.

", "DescribeHyperParameterTuningJobResponse$OverallBestTrainingJob": "

If the hyperparameter tuning job is an warm start tuning job with a WarmStartType of IDENTICAL_DATA_AND_ALGORITHM, this is the TrainingJobSummary for the training job with the best objective metric value of all training jobs launched by this tuning job and all parent jobs specified for the warm start tuning job.

", - "HyperParameterTrainingJobSummaries$member": null + "HyperParameterTrainingJobSummaries$member": null, + "HyperParameterTuningJobSearchEntity$BestTrainingJob": null, + "HyperParameterTuningJobSearchEntity$OverallBestTrainingJob": null } }, "HyperParameterTuningAllocationStrategy": { @@ -5131,6 +5136,7 @@ "CreateHyperParameterTuningJobResponse$HyperParameterTuningJobArn": "

The Amazon Resource Name (ARN) of the tuning job. SageMaker assigns an ARN to a hyperparameter tuning job when you create it.

", "DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobArn": "

The Amazon Resource Name (ARN) of the tuning job.

", "DescribeTrainingJobResponse$TuningJobArn": "

The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

", + "HyperParameterTuningJobSearchEntity$HyperParameterTuningJobArn": "

The Amazon Resource Name (ARN) of a hyperparameter tuning job.

", "HyperParameterTuningJobSummary$HyperParameterTuningJobArn": "

The Amazon Resource Name (ARN) of the tuning job.

", "TrainingJob$TuningJobArn": "

The Amazon Resource Name (ARN) of the associated hyperparameter tuning job if the training job was launched by a hyperparameter tuning job.

", "TuningJobStepMetaData$Arn": "

The Amazon Resource Name (ARN) of the tuning job that was run by this step execution.

" @@ -5140,7 +5146,8 @@ "base": "

Configures a hyperparameter tuning job.

", "refs": { "CreateHyperParameterTuningJobRequest$HyperParameterTuningJobConfig": "

The HyperParameterTuningJobConfig object that describes the tuning job, including the search strategy, the objective metric used to evaluate training jobs, ranges of parameters to search, and resource limits for the tuning job. For more information, see How Hyperparameter Tuning Works.

", - "DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobConfig": "

The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.

" + "DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobConfig": "

The HyperParameterTuningJobConfig object that specifies the configuration of the tuning job.

", + "HyperParameterTuningJobSearchEntity$HyperParameterTuningJobConfig": null } }, "HyperParameterTuningJobName": { @@ -5150,6 +5157,7 @@ "DescribeHyperParameterTuningJobRequest$HyperParameterTuningJobName": "

The name of the tuning job.

", "DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobName": "

The name of the tuning job.

", "HyperParameterTrainingJobSummary$TuningJobName": "

The HyperParameter tuning job that launched the training job.

", + "HyperParameterTuningJobSearchEntity$HyperParameterTuningJobName": "

The name of a hyperparameter tuning job.

", "HyperParameterTuningJobSummary$HyperParameterTuningJobName": "

The name of the tuning job.

", "ListTrainingJobsForHyperParameterTuningJobRequest$HyperParameterTuningJobName": "

The name of the tuning job whose training jobs you want to list.

", "ParentHyperParameterTuningJob$HyperParameterTuningJobName": "

The name of the hyperparameter tuning job to be used as a starting point for a new hyperparameter tuning job.

", @@ -5177,6 +5185,12 @@ "TrainingSpecification$SupportedTuningJobObjectiveMetrics": "

A list of the metrics that the algorithm emits that can be used as the objective metric in a hyperparameter tuning job.

" } }, + "HyperParameterTuningJobSearchEntity": { + "base": "

An entity having characteristics over which a user can search for a hyperparameter tuning job.

", + "refs": { + "SearchRecord$HyperParameterTuningJob": "

The properties of a hyperparameter tuning job.

" + } + }, "HyperParameterTuningJobSortByOptions": { "base": null, "refs": { @@ -5187,6 +5201,7 @@ "base": null, "refs": { "DescribeHyperParameterTuningJobResponse$HyperParameterTuningJobStatus": "

The status of the tuning job: InProgress, Completed, Failed, Stopping, or Stopped.

", + "HyperParameterTuningJobSearchEntity$HyperParameterTuningJobStatus": "

The status of a hyperparameter tuning job.

", "HyperParameterTuningJobSummary$HyperParameterTuningJobStatus": "

The status of the tuning job.

", "ListHyperParameterTuningJobsRequest$StatusEquals": "

A filter that returns only tuning jobs with the specified status.

" } @@ -5214,7 +5229,8 @@ "base": "

Specifies the configuration for a hyperparameter tuning job that uses one or more previous hyperparameter tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric, and the training job that performs the best is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.

All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.

", "refs": { "CreateHyperParameterTuningJobRequest$WarmStartConfig": "

Specifies the configuration for starting the hyperparameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

All training jobs launched by the new hyperparameter tuning job are evaluated by using the objective metric. If you specify IDENTICAL_DATA_AND_ALGORITHM as the WarmStartType value for the warm start configuration, the training job that performs the best in the new tuning job is compared to the best training jobs from the parent tuning jobs. From these, the training job that performs the best as measured by the objective metric is returned as the overall best training job.

All training jobs launched by parent hyperparameter tuning jobs and the new hyperparameter tuning jobs count against the limit of training jobs for the tuning job.

", - "DescribeHyperParameterTuningJobResponse$WarmStartConfig": "

The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

" + "DescribeHyperParameterTuningJobResponse$WarmStartConfig": "

The configuration for starting the hyperparameter parameter tuning job using one or more previous tuning jobs as a starting point. The results of previous tuning jobs are used to inform which combinations of hyperparameters to search over in the new tuning job.

", + "HyperParameterTuningJobSearchEntity$WarmStartConfig": null } }, "HyperParameterTuningJobWarmStartType": { @@ -8251,6 +8267,7 @@ "base": "

Specifies the number of training jobs that this hyperparameter tuning job launched, categorized by the status of their objective metric. The objective metric status shows whether the final objective metric for the training job has been evaluated by the tuning job and used in the hyperparameter tuning process.

", "refs": { "DescribeHyperParameterTuningJobResponse$ObjectiveStatusCounters": "

The ObjectiveStatusCounters object that specifies the number of training jobs, categorized by the status of their final objective metric, that this tuning job launched.

", + "HyperParameterTuningJobSearchEntity$ObjectiveStatusCounters": null, "HyperParameterTuningJobSummary$ObjectiveStatusCounters": "

The ObjectiveStatusCounters object that specifies the numbers of training jobs, categorized by objective metric status, that this tuning job launched.

" } }, @@ -10811,6 +10828,7 @@ "Endpoint$Tags": "

A list of the tags associated with the endpoint. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

", "Experiment$Tags": "

The list of tags that are associated with the experiment. You can use Search API to search on the tags.

", "FeatureGroup$Tags": "

Tags used to define a FeatureGroup.

", + "HyperParameterTuningJobSearchEntity$Tags": "

The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.

", "ListTagsOutput$Tags": "

An array of Tag objects, each with a tag key and a value.

", "ModelPackage$Tags": "

A list of the tags associated with the model package. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

", "ModelPackageGroup$Tags": "

A list of the tags associated with the model group. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

", @@ -11111,6 +11129,9 @@ "HyperParameterTrainingJobSummary$CreationTime": "

The date and time that the training job was created.

", "HyperParameterTrainingJobSummary$TrainingStartTime": "

The date and time that the training job started.

", "HyperParameterTrainingJobSummary$TrainingEndTime": "

Specifies the time when the training job ends on training instances. You are billed for the time interval between the value of TrainingStartTime and this time. For successful jobs and stopped jobs, this is the time after model artifacts are uploaded. For failed jobs, this is the time when SageMaker detects a job failure.

", + "HyperParameterTuningJobSearchEntity$CreationTime": "

The time that a hyperparameter tuning job was created.

", + "HyperParameterTuningJobSearchEntity$HyperParameterTuningEndTime": "

The time that a hyperparameter tuning job ended.

", + "HyperParameterTuningJobSearchEntity$LastModifiedTime": "

The time that a hyperparameter tuning job was last modified.

", "HyperParameterTuningJobSummary$CreationTime": "

The date and time that the tuning job was created.

", "HyperParameterTuningJobSummary$HyperParameterTuningEndTime": "

The date and time that the tuning job ended.

", "HyperParameterTuningJobSummary$LastModifiedTime": "

The date and time that the tuning job was modified.

", @@ -11473,6 +11494,7 @@ "base": "

The numbers of training jobs launched by a hyperparameter tuning job, categorized by status.

", "refs": { "DescribeHyperParameterTuningJobResponse$TrainingJobStatusCounters": "

The TrainingJobStatusCounters object that specifies the number of training jobs, categorized by status, that this tuning job launched.

", + "HyperParameterTuningJobSearchEntity$TrainingJobStatusCounters": null, "HyperParameterTuningJobSummary$TrainingJobStatusCounters": "

The TrainingJobStatusCounters object that specifies the numbers of training jobs, categorized by status, that this tuning job launched.

" } }, diff --git a/service/identitystore/api.go b/service/identitystore/api.go index a74dd5792cf..6bb1aafacf8 100644 --- a/service/identitystore/api.go +++ b/service/identitystore/api.go @@ -776,7 +776,8 @@ func (c *IdentityStore) DescribeGroupMembershipRequest(input *DescribeGroupMembe // DescribeGroupMembership API operation for AWS SSO Identity Store. // -// Retrieves membership metadata and attributes from MembershipId in a group. +// Retrieves membership metadata and attributes from MembershipId in an identity +// store. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1056,7 +1057,7 @@ func (c *IdentityStore) GetGroupMembershipIdRequest(input *GetGroupMembershipIdI // GetGroupMembershipId API operation for AWS SSO Identity Store. // -// Retrieves the MembershipId in a group. +// Retrieves the MembershipId in an identity store. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1242,7 +1243,8 @@ func (c *IdentityStore) IsMemberInGroupsRequest(input *IsMemberInGroupsInput) (r // IsMemberInGroups API operation for AWS SSO Identity Store. // -// Returns if a member exists in specified groups. +// Checks the user's membership in all requested groups and returns if the member +// exists in all queried groups. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1643,11 +1645,10 @@ func (c *IdentityStore) ListGroupsRequest(input *ListGroupsInput) (req *request. // ListGroups API operation for AWS SSO Identity Store. // -// Filtering for a group by the group DisplayName attribute is deprecated. Instead, -// use the GetGroupId API action. -// -// Lists all groups in the identity store. Returns a paginated list of complete -// Group objects. +// Lists the attribute name and value of the group that you specified in the +// search. We only support DisplayName as a valid filter attribute path currently, +// and filter is required. This API returns minimum attributes, including GroupId +// and group DisplayName in the response. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -1797,11 +1798,10 @@ func (c *IdentityStore) ListUsersRequest(input *ListUsersInput) (req *request.Re // ListUsers API operation for AWS SSO Identity Store. // -// Filtering for a user by the UserName attribute is deprecated. Instead, use -// the GetUserId API action. -// -// Lists all users in the identity store. Returns a paginated list of complete -// User objects. +// Lists the attribute name and value of the user that you specified in the +// search. We only support UserName as a valid filter attribute path currently, +// and filter is required. This API returns minimum attributes, including UserId +// and UserName in the response. // // Returns awserr.Error for service API and SDK errors. Use runtime type assertions // with awserr.Error's Code and Message methods to get detailed information about @@ -2219,8 +2219,8 @@ type Address struct { // String and GoString methods. PostalCode *string `min:"1" type:"string" sensitive:"true"` - // A boolean representing whether this is the primary address for the associated - // resource. + // A Boolean value representing whether this is the primary address for the + // associated resource. // // Primary is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by Address's @@ -2346,7 +2346,7 @@ func (s *Address) SetType(v string) *Address { return s } -// A unique identifier for the group value that is not the group's primary identifier. +// A unique identifier for a user or group that is not the its primary identifier. // This value can be an identifier from an external identity provider (IdP) // that is associated with the group or a unique attribute. For example, a unique // GroupDisplayName. @@ -2709,7 +2709,7 @@ type CreateGroupMembershipOutput struct { // IdentityStoreId is a required field IdentityStoreId *string `min:"1" type:"string" required:"true"` - // The identifier for a GroupMembership in the identity store. + // The identifier for a newly created GroupMembership in an identity store. // // MembershipId is a required field MembershipId *string `min:"1" type:"string" required:"true"` @@ -2864,9 +2864,8 @@ type CreateUserInput struct { // A unique string used to identify the user. The length limit is 128 characters. // This value can consist of letters, accented characters, symbols, numbers, - // and punctuation. The characters <>;:% are excluded. This value is specified - // at the time the user is created and stored as an attribute of the user object - // in the identity store. + // and punctuation. This value is specified at the time the user is created + // and stored as an attribute of the user object in the identity store. // // UserName is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by CreateUserInput's @@ -3189,7 +3188,7 @@ type DeleteGroupMembershipInput struct { // IdentityStoreId is a required field IdentityStoreId *string `min:"1" type:"string" required:"true"` - // The identifier for a GroupMembership in the identity store. + // The identifier for a GroupMembership in an identity store. // // MembershipId is a required field MembershipId *string `min:"1" type:"string" required:"true"` @@ -3456,7 +3455,7 @@ type DescribeGroupMembershipInput struct { // IdentityStoreId is a required field IdentityStoreId *string `min:"1" type:"string" required:"true"` - // The identifier for a GroupMembership in the identity store. + // The identifier for a GroupMembership in an identity store. // // MembershipId is a required field MembershipId *string `min:"1" type:"string" required:"true"` @@ -3532,7 +3531,7 @@ type DescribeGroupMembershipOutput struct { // MemberId is a required field MemberId *MemberId `type:"structure" required:"true"` - // The identifier for a GroupMembership in the identity store. + // The identifier for a GroupMembership in an identity store. // // MembershipId is a required field MembershipId *string `min:"1" type:"string" required:"true"` @@ -3812,11 +3811,10 @@ type DescribeUserOutput struct { // UserId is a required field UserId *string `min:"1" type:"string" required:"true"` - // The user’s username value. The length limit is 128 characters. This value - // can consist of letters, accented characters, symbols, numbers, and punctuation. - // The characters <>;:% are excluded. This value is specified at the time the - // user is created and stored as an attribute of the user object in the identity - // store. + // A unique string used to identify the user. The length limit is 128 characters. + // This value can consist of letters, accented characters, symbols, numbers, + // and punctuation. This value is specified at the time the user is created + // and stored as an attribute of the user object in the identity store. // // UserName is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by DescribeUserOutput's @@ -3949,8 +3947,8 @@ func (s *DescribeUserOutput) SetUserType(v string) *DescribeUserOutput { type Email struct { _ struct{} `type:"structure"` - // A boolean representing whether this is the primary email for the associated - // resource. + // A Boolean value representing whether this is the primary email address for + // the associated resource. // // Primary is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by Email's @@ -4178,7 +4176,7 @@ func (s *Filter) SetAttributeValue(v string) *Filter { type GetGroupIdInput struct { _ struct{} `type:"structure"` - // A unique identifier for the group value that is not the group's primary identifier. + // A unique identifier for an identity resource that is not the primary identifier. // This value can be an identifier from an external identity provider (IdP) // that is associated with the group or a unique attribute. For example, a unique // GroupDisplayName. @@ -4385,7 +4383,7 @@ type GetGroupMembershipIdOutput struct { // IdentityStoreId is a required field IdentityStoreId *string `min:"1" type:"string" required:"true"` - // The identifier for a GroupMembership in the identity store. + // The identifier for a GroupMembership in an identity store. // // MembershipId is a required field MembershipId *string `min:"1" type:"string" required:"true"` @@ -4424,7 +4422,7 @@ func (s *GetGroupMembershipIdOutput) SetMembershipId(v string) *GetGroupMembersh type GetUserIdInput struct { _ struct{} `type:"structure"` - // Any unique attribute associated with a user that is not the UserId. + // A unique identifier for an identity resource that is not the primary identifier. // // AlternateIdentifier is a required field AlternateIdentifier *AlternateIdentifier `type:"structure" required:"true"` @@ -4637,7 +4635,7 @@ type GroupMembership struct { // member of the group. MemberId *MemberId `type:"structure"` - // The identifier for a GroupMembership object in the identity store. + // The identifier for a GroupMembership object in an identity store. MembershipId *string `min:"1" type:"string"` } @@ -4901,7 +4899,7 @@ func (s *IsMemberInGroupsInput) SetMemberId(v *MemberId) *IsMemberInGroupsInput type IsMemberInGroupsOutput struct { _ struct{} `type:"structure"` - // An object containing results of batch IsMemberInGroups call. + // A list containing the results of membership existence checks. // // Results is a required field Results []*GroupMembershipExistenceResult `type:"list" required:"true"` @@ -4951,7 +4949,7 @@ type ListGroupMembershipsForMemberInput struct { // MemberId is a required field MemberId *MemberId `type:"structure" required:"true"` - // The pagination token used for the ListUsers, ListGroups and ListGroupMemberships + // The pagination token used for the ListUsers, ListGroups, and ListGroupMemberships // API operations. This value is generated by the identity store service. It // is returned in the API response if the total results are more than the size // of one page. This token is also returned when it is used in the API request @@ -5039,7 +5037,7 @@ type ListGroupMembershipsForMemberOutput struct { // GroupMemberships is a required field GroupMemberships []*GroupMembership `type:"list" required:"true"` - // The pagination token used for the ListUsers, ListGroups and ListGroupMemberships + // The pagination token used for the ListUsers, ListGroups, and ListGroupMemberships // API operations. This value is generated by the identity store service. It // is returned in the API response if the total results are more than the size // of one page. This token is also returned when it is used in the API request @@ -5091,8 +5089,8 @@ type ListGroupMembershipsInput struct { IdentityStoreId *string `min:"1" type:"string" required:"true"` // The maximum number of results to be returned per request. This parameter - // is used in the ListUsers and ListGroups requests to specify how many results - // to return in one page. The length limit is 50 characters. + // is used in all List requests to specify how many results to return in one + // page. MaxResults *int64 `min:"1" type:"integer"` // The pagination token used for the ListUsers, ListGroups and ListGroupMemberships @@ -5181,7 +5179,7 @@ type ListGroupMembershipsOutput struct { // GroupMemberships is a required field GroupMemberships []*GroupMembership `type:"list" required:"true"` - // The pagination token used for the ListUsers, ListGroups and ListGroupMemberships + // The pagination token used for the ListUsers, ListGroups, and ListGroupMemberships // API operations. This value is generated by the identity store service. It // is returned in the API response if the total results are more than the size // of one page. This token is also returned when it is used in the API request @@ -5222,7 +5220,7 @@ func (s *ListGroupMembershipsOutput) SetNextToken(v string) *ListGroupMembership type ListGroupsInput struct { _ struct{} `type:"structure"` - // A list of Filter objects that is used in the ListUsers and ListGroups requests. + // A list of Filter objects, which is used in the ListUsers and ListGroups requests. // // Deprecated: Using filters with ListGroups API is deprecated, please use GetGroupId API instead. Filters []*Filter `deprecated:"true" type:"list"` @@ -5371,7 +5369,7 @@ func (s *ListGroupsOutput) SetNextToken(v string) *ListGroupsOutput { type ListUsersInput struct { _ struct{} `type:"structure"` - // A list of Filter objects that is used in the ListUsers and ListGroups requests. + // A list of Filter objects, which is used in the ListUsers and ListGroups requests. // // Deprecated: Using filters with ListUsers API is deprecated, please use GetGroupId API instead. Filters []*Filter `deprecated:"true" type:"list"` @@ -5562,7 +5560,7 @@ func (s *MemberId) SetUserId(v string) *MemberId { return s } -// The name of the user. +// The full name of the user. type Name struct { _ struct{} `type:"structure"` @@ -5695,8 +5693,8 @@ func (s *Name) SetMiddleName(v string) *Name { type PhoneNumber struct { _ struct{} `type:"structure"` - // A boolean representing whether this is the primary phone number for the associated - // resource. + // A Boolean value representing whether this is the primary phone number for + // the associated resource. // // Primary is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by PhoneNumber's @@ -6299,7 +6297,7 @@ type User struct { Timezone *string `min:"1" type:"string" sensitive:"true"` // A string containing the user's title. Possible values depend on each customer's - // specific needs, so they are left unspecified + // specific needs, so they are left unspecified. // // Title is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by User's @@ -6311,11 +6309,10 @@ type User struct { // UserId is a required field UserId *string `min:"1" type:"string" required:"true"` - // The user’s user name value. The length limit is 128 characters. This value - // can consist of letters, accented characters, symbols, numbers, and punctuation. - // The characters <>;:% are excluded. This value is specified at the time the - // user is created and stored as an attribute of the user object in the identity - // store. + // A unique string used to identify the user. The length limit is 128 characters. + // This value can consist of letters, accented characters, symbols, numbers, + // and punctuation. This value is specified at the time the user is created + // and stored as an attribute of the user object in the identity store. // // UserName is a sensitive parameter and its value will be // replaced with "sensitive" in string returned by User's diff --git a/service/identitystore/doc.go b/service/identitystore/doc.go index 72d023b8a55..31313b236c5 100644 --- a/service/identitystore/doc.go +++ b/service/identitystore/doc.go @@ -3,9 +3,18 @@ // Package identitystore provides the client and types for making API // requests to AWS SSO Identity Store. // -// The AWS Single Sign-On (SSO) Identity Store service provides a single place -// to retrieve all of your identities (users and groups). For more information -// about AWS, see the AWS Single Sign-On User Guide (https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html). +// The Identity Store service used by AWS IAM Identity Center (successor to +// AWS Single Sign-On) provides a single place to retrieve all of your identities +// (users and groups). For more information, see the IAM Identity Center User +// Guide (https://docs.aws.amazon.com/singlesignon/latest/userguide/what-is.html). +// +//

Although AWS Single Sign-On was renamed, the sso +// and identitystore API namespaces will continue to retain +// their original name for backward compatibility purposes. For more information, +// see IAM +// Identity Center rename.

This reference guide describes +// the identity store operations that you can call programatically and includes +// detailed information on data types and errors.

// // See https://docs.aws.amazon.com/goto/WebAPI/identitystore-2020-06-15 for more information on this service. // diff --git a/service/sagemaker/api.go b/service/sagemaker/api.go index fbabe28eae5..6ddfa835363 100644 --- a/service/sagemaker/api.go +++ b/service/sagemaker/api.go @@ -62192,6 +62192,193 @@ func (s *HyperParameterTuningJobObjective) SetType(v string) *HyperParameterTuni return s } +// An entity having characteristics over which a user can search for a hyperparameter +// tuning job. +type HyperParameterTuningJobSearchEntity struct { + _ struct{} `type:"structure"` + + // The container for the summary information about a training job. + BestTrainingJob *HyperParameterTrainingJobSummary `type:"structure"` + + // The time that a hyperparameter tuning job was created. + CreationTime *time.Time `type:"timestamp"` + + // The error that was created when a hyperparameter tuning job failed. + FailureReason *string `type:"string"` + + // The time that a hyperparameter tuning job ended. + HyperParameterTuningEndTime *time.Time `type:"timestamp"` + + // The Amazon Resource Name (ARN) of a hyperparameter tuning job. + HyperParameterTuningJobArn *string `type:"string"` + + // Configures a hyperparameter tuning job. + HyperParameterTuningJobConfig *HyperParameterTuningJobConfig `type:"structure"` + + // The name of a hyperparameter tuning job. + HyperParameterTuningJobName *string `min:"1" type:"string"` + + // The status of a hyperparameter tuning job. + HyperParameterTuningJobStatus *string `type:"string" enum:"HyperParameterTuningJobStatus"` + + // The time that a hyperparameter tuning job was last modified. + LastModifiedTime *time.Time `type:"timestamp"` + + // Specifies the number of training jobs that this hyperparameter tuning job + // launched, categorized by the status of their objective metric. The objective + // metric status shows whether the final objective metric for the training job + // has been evaluated by the tuning job and used in the hyperparameter tuning + // process. + ObjectiveStatusCounters *ObjectiveStatusCounters `type:"structure"` + + // The container for the summary information about a training job. + OverallBestTrainingJob *HyperParameterTrainingJobSummary `type:"structure"` + + // The tags associated with a hyperparameter tuning job. For more information + // see Tagging Amazon Web Services resources (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html). + Tags []*Tag `type:"list"` + + // Defines the training jobs launched by a hyperparameter tuning job. + TrainingJobDefinition *HyperParameterTrainingJobDefinition `type:"structure"` + + // The job definitions included in a hyperparameter tuning job. + TrainingJobDefinitions []*HyperParameterTrainingJobDefinition `min:"1" type:"list"` + + // The numbers of training jobs launched by a hyperparameter tuning job, categorized + // by status. + TrainingJobStatusCounters *TrainingJobStatusCounters `type:"structure"` + + // Specifies the configuration for a hyperparameter tuning job that uses one + // or more previous hyperparameter tuning jobs as a starting point. The results + // of previous tuning jobs are used to inform which combinations of hyperparameters + // to search over in the new tuning job. + // + // All training jobs launched by the new hyperparameter tuning job are evaluated + // by using the objective metric, and the training job that performs the best + // is compared to the best training jobs from the parent tuning jobs. From these, + // the training job that performs the best as measured by the objective metric + // is returned as the overall best training job. + // + // All training jobs launched by parent hyperparameter tuning jobs and the new + // hyperparameter tuning jobs count against the limit of training jobs for the + // tuning job. + WarmStartConfig *HyperParameterTuningJobWarmStartConfig `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s HyperParameterTuningJobSearchEntity) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s HyperParameterTuningJobSearchEntity) GoString() string { + return s.String() +} + +// SetBestTrainingJob sets the BestTrainingJob field's value. +func (s *HyperParameterTuningJobSearchEntity) SetBestTrainingJob(v *HyperParameterTrainingJobSummary) *HyperParameterTuningJobSearchEntity { + s.BestTrainingJob = v + return s +} + +// SetCreationTime sets the CreationTime field's value. +func (s *HyperParameterTuningJobSearchEntity) SetCreationTime(v time.Time) *HyperParameterTuningJobSearchEntity { + s.CreationTime = &v + return s +} + +// SetFailureReason sets the FailureReason field's value. +func (s *HyperParameterTuningJobSearchEntity) SetFailureReason(v string) *HyperParameterTuningJobSearchEntity { + s.FailureReason = &v + return s +} + +// SetHyperParameterTuningEndTime sets the HyperParameterTuningEndTime field's value. +func (s *HyperParameterTuningJobSearchEntity) SetHyperParameterTuningEndTime(v time.Time) *HyperParameterTuningJobSearchEntity { + s.HyperParameterTuningEndTime = &v + return s +} + +// SetHyperParameterTuningJobArn sets the HyperParameterTuningJobArn field's value. +func (s *HyperParameterTuningJobSearchEntity) SetHyperParameterTuningJobArn(v string) *HyperParameterTuningJobSearchEntity { + s.HyperParameterTuningJobArn = &v + return s +} + +// SetHyperParameterTuningJobConfig sets the HyperParameterTuningJobConfig field's value. +func (s *HyperParameterTuningJobSearchEntity) SetHyperParameterTuningJobConfig(v *HyperParameterTuningJobConfig) *HyperParameterTuningJobSearchEntity { + s.HyperParameterTuningJobConfig = v + return s +} + +// SetHyperParameterTuningJobName sets the HyperParameterTuningJobName field's value. +func (s *HyperParameterTuningJobSearchEntity) SetHyperParameterTuningJobName(v string) *HyperParameterTuningJobSearchEntity { + s.HyperParameterTuningJobName = &v + return s +} + +// SetHyperParameterTuningJobStatus sets the HyperParameterTuningJobStatus field's value. +func (s *HyperParameterTuningJobSearchEntity) SetHyperParameterTuningJobStatus(v string) *HyperParameterTuningJobSearchEntity { + s.HyperParameterTuningJobStatus = &v + return s +} + +// SetLastModifiedTime sets the LastModifiedTime field's value. +func (s *HyperParameterTuningJobSearchEntity) SetLastModifiedTime(v time.Time) *HyperParameterTuningJobSearchEntity { + s.LastModifiedTime = &v + return s +} + +// SetObjectiveStatusCounters sets the ObjectiveStatusCounters field's value. +func (s *HyperParameterTuningJobSearchEntity) SetObjectiveStatusCounters(v *ObjectiveStatusCounters) *HyperParameterTuningJobSearchEntity { + s.ObjectiveStatusCounters = v + return s +} + +// SetOverallBestTrainingJob sets the OverallBestTrainingJob field's value. +func (s *HyperParameterTuningJobSearchEntity) SetOverallBestTrainingJob(v *HyperParameterTrainingJobSummary) *HyperParameterTuningJobSearchEntity { + s.OverallBestTrainingJob = v + return s +} + +// SetTags sets the Tags field's value. +func (s *HyperParameterTuningJobSearchEntity) SetTags(v []*Tag) *HyperParameterTuningJobSearchEntity { + s.Tags = v + return s +} + +// SetTrainingJobDefinition sets the TrainingJobDefinition field's value. +func (s *HyperParameterTuningJobSearchEntity) SetTrainingJobDefinition(v *HyperParameterTrainingJobDefinition) *HyperParameterTuningJobSearchEntity { + s.TrainingJobDefinition = v + return s +} + +// SetTrainingJobDefinitions sets the TrainingJobDefinitions field's value. +func (s *HyperParameterTuningJobSearchEntity) SetTrainingJobDefinitions(v []*HyperParameterTrainingJobDefinition) *HyperParameterTuningJobSearchEntity { + s.TrainingJobDefinitions = v + return s +} + +// SetTrainingJobStatusCounters sets the TrainingJobStatusCounters field's value. +func (s *HyperParameterTuningJobSearchEntity) SetTrainingJobStatusCounters(v *TrainingJobStatusCounters) *HyperParameterTuningJobSearchEntity { + s.TrainingJobStatusCounters = v + return s +} + +// SetWarmStartConfig sets the WarmStartConfig field's value. +func (s *HyperParameterTuningJobSearchEntity) SetWarmStartConfig(v *HyperParameterTuningJobWarmStartConfig) *HyperParameterTuningJobSearchEntity { + s.WarmStartConfig = v + return s +} + // Provides summary information about a hyperparameter tuning job. type HyperParameterTuningJobSummary struct { _ struct{} `type:"structure"` @@ -87170,6 +87357,9 @@ type SearchRecord struct { // The feature metadata used to search through the features. FeatureMetadata *FeatureMetadata `type:"structure"` + // The properties of a hyperparameter tuning job. + HyperParameterTuningJob *HyperParameterTuningJobSearchEntity `type:"structure"` + // A versioned model that can be deployed for SageMaker inference. ModelPackage *ModelPackage `type:"structure"` @@ -87237,6 +87427,12 @@ func (s *SearchRecord) SetFeatureMetadata(v *FeatureMetadata) *SearchRecord { return s } +// SetHyperParameterTuningJob sets the HyperParameterTuningJob field's value. +func (s *SearchRecord) SetHyperParameterTuningJob(v *HyperParameterTuningJobSearchEntity) *SearchRecord { + s.HyperParameterTuningJob = v + return s +} + // SetModelPackage sets the ModelPackage field's value. func (s *SearchRecord) SetModelPackage(v *ModelPackage) *SearchRecord { s.ModelPackage = v @@ -101931,6 +102127,9 @@ const ( // ResourceTypeFeatureMetadata is a ResourceType enum value ResourceTypeFeatureMetadata = "FeatureMetadata" + + // ResourceTypeHyperParameterTuningJob is a ResourceType enum value + ResourceTypeHyperParameterTuningJob = "HyperParameterTuningJob" ) // ResourceType_Values returns all elements of the ResourceType enum @@ -101948,6 +102147,7 @@ func ResourceType_Values() []string { ResourceTypeFeatureGroup, ResourceTypeProject, ResourceTypeFeatureMetadata, + ResourceTypeHyperParameterTuningJob, } }