Class CreateConfiguredAudienceModelRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.cleanroomsml.model.CleanRoomsMlRequest
software.amazon.awssdk.services.cleanroomsml.model.CreateConfiguredAudienceModelRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateConfiguredAudienceModelRequest.Builder,CreateConfiguredAudienceModelRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateConfiguredAudienceModelRequest extends CleanRoomsMlRequest implements ToCopyableBuilder<CreateConfiguredAudienceModelRequest.Builder,CreateConfiguredAudienceModelRequest>

  • Method Details

    • name

      public final String name()

      The name of the configured audience model.

      Returns:
      The name of the configured audience model.

    • audienceModelArn

      public final String audienceModelArn()

      The Amazon Resource Name (ARN) of the audience model to use for the configured audience model.

      Returns:
      The Amazon Resource Name (ARN) of the audience model to use for the configured audience model.

    • outputConfig

      public final ConfiguredAudienceModelOutputConfig outputConfig()

      Configure the Amazon S3 location and IAM Role for audiences created using this configured audience model. Each audience will have a unique location. The IAM Role must have s3:PutObject permission on the destination Amazon S3 location. If the destination is protected with Amazon S3 KMS-SSE, then the Role must also have the required KMS permissions.

      Returns:
      Configure the Amazon S3 location and IAM Role for audiences created using this configured audience model. Each audience will have a unique location. The IAM Role must have s3:PutObject permission on the destination Amazon S3 location. If the destination is protected with Amazon S3 KMS-SSE, then the Role must also have the required KMS permissions.

    • description

      public final String description()

      The description of the configured audience model.

      Returns:
      The description of the configured audience model.

    • sharedAudienceMetrics

      public final List<SharedAudienceMetrics> sharedAudienceMetrics()

      Whether audience metrics are shared.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSharedAudienceMetrics() method.

      Returns:
      Whether audience metrics are shared.

    • hasSharedAudienceMetrics

      public final boolean hasSharedAudienceMetrics()
      For responses, this returns true if the service returned a value for the SharedAudienceMetrics property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • sharedAudienceMetricsAsStrings

      public final List<String> sharedAudienceMetricsAsStrings()

      Whether audience metrics are shared.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSharedAudienceMetrics() method.

      Returns:
      Whether audience metrics are shared.

    • minMatchingSeedSize

      public final Integer minMatchingSeedSize()

      The minimum number of users from the seed audience that must match with users in the training data of the audience model. The default value is 500.

      Returns:
      The minimum number of users from the seed audience that must match with users in the training data of the audience model. The default value is 500.

    • audienceSizeConfig

      public final AudienceSizeConfig audienceSizeConfig()

      Configure the list of output sizes of audiences that can be created using this configured audience model. A request to StartAudienceGenerationJob that uses this configured audience model must have an audienceSize selected from this list. You can use the ABSOLUTE AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the Percentage AudienceSize to configure sizes in the range 1-100 percent.

      Returns:
      Configure the list of output sizes of audiences that can be created using this configured audience model. A request to StartAudienceGenerationJob that uses this configured audience model must have an audienceSize selected from this list. You can use the ABSOLUTE AudienceSize to configure out audience sizes using the count of identifiers in the output. You can use the Percentage AudienceSize to configure sizes in the range 1-100 percent.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final Map<String,String> tags()

      The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

      The following basic restrictions apply to tags:

      • Maximum number of tags per resource - 50.

      • For each resource, each tag key must be unique, and each tag key can have only one value.

      • Maximum key length - 128 Unicode characters in UTF-8.

      • Maximum value length - 256 Unicode characters in UTF-8.

      • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

      • Tag keys and values are case sensitive.

      • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      The optional metadata that you apply to the resource to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.

      The following basic restrictions apply to tags:

      • Maximum number of tags per resource - 50.

      • For each resource, each tag key must be unique, and each tag key can have only one value.

      • Maximum key length - 128 Unicode characters in UTF-8.

      • Maximum value length - 256 Unicode characters in UTF-8.

      • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

      • Tag keys and values are case sensitive.

      • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for keys as it is reserved for AWS use. You cannot edit or delete tag keys with this prefix. Values can have this prefix. If a tag value has aws as its prefix but the key does not, then Clean Rooms ML considers it to be a user tag and will count against the limit of 50 tags. Tags with only the key prefix of aws do not count against your tags per resource limit.

    • childResourceTagOnCreatePolicy

      public final TagOnCreatePolicy childResourceTagOnCreatePolicy()

      Configure how the service tags audience generation jobs created using this configured audience model. If you specify NONE, the tags from the StartAudienceGenerationJob request determine the tags of the audience generation job. If you specify FROM_PARENT_RESOURCE, the audience generation job inherits the tags from the configured audience model, by default. Tags in the StartAudienceGenerationJob will override the default.

      When the client is in a different account than the configured audience model, the tags from the client are never applied to a resource in the caller's account.

      If the service returns an enum value that is not available in the current SDK version, childResourceTagOnCreatePolicy will return TagOnCreatePolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from childResourceTagOnCreatePolicyAsString().

      Returns:
      Configure how the service tags audience generation jobs created using this configured audience model. If you specify NONE, the tags from the StartAudienceGenerationJob request determine the tags of the audience generation job. If you specify FROM_PARENT_RESOURCE, the audience generation job inherits the tags from the configured audience model, by default. Tags in the StartAudienceGenerationJob will override the default.

      When the client is in a different account than the configured audience model, the tags from the client are never applied to a resource in the caller's account.

      See Also:

    • childResourceTagOnCreatePolicyAsString

      public final String childResourceTagOnCreatePolicyAsString()

      Configure how the service tags audience generation jobs created using this configured audience model. If you specify NONE, the tags from the StartAudienceGenerationJob request determine the tags of the audience generation job. If you specify FROM_PARENT_RESOURCE, the audience generation job inherits the tags from the configured audience model, by default. Tags in the StartAudienceGenerationJob will override the default.

      When the client is in a different account than the configured audience model, the tags from the client are never applied to a resource in the caller's account.

      If the service returns an enum value that is not available in the current SDK version, childResourceTagOnCreatePolicy will return TagOnCreatePolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from childResourceTagOnCreatePolicyAsString().

      Returns:
      Configure how the service tags audience generation jobs created using this configured audience model. If you specify NONE, the tags from the StartAudienceGenerationJob request determine the tags of the audience generation job. If you specify FROM_PARENT_RESOURCE, the audience generation job inherits the tags from the configured audience model, by default. Tags in the StartAudienceGenerationJob will override the default.

      When the client is in a different account than the configured audience model, the tags from the client are never applied to a resource in the caller's account.

      See Also:

    • toBuilder

      public CreateConfiguredAudienceModelRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateConfiguredAudienceModelRequest.Builder,CreateConfiguredAudienceModelRequest>
      Specified by:
      toBuilder in class CleanRoomsMlRequest
      Returns:
      a builder for type T

    • builder

      public static CreateConfiguredAudienceModelRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateConfiguredAudienceModelRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.