Package software.amazon.awssdk.services.cleanroomsml.model

Interface StartAudienceGenerationJobRequest.Builder

    • Method Detail

      • collaborationId

        StartAudienceGenerationJobRequest.Builder collaborationId​(String collaborationId)

        The identifier of the collaboration that contains the audience generation job.

        Parameters:
        collaborationId - The identifier of the collaboration that contains the audience generation job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • configuredAudienceModelArn

        StartAudienceGenerationJobRequest.Builder configuredAudienceModelArn​(String configuredAudienceModelArn)

        The Amazon Resource Name (ARN) of the configured audience model that is used for this audience generation job.

        Parameters:
        configuredAudienceModelArn - The Amazon Resource Name (ARN) of the configured audience model that is used for this audience generation job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        StartAudienceGenerationJobRequest.Builder description​(String description)

        The description of the audience generation job.

        Parameters:
        description - The description of the audience generation job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • includeSeedInOutput

        StartAudienceGenerationJobRequest.Builder includeSeedInOutput​(Boolean includeSeedInOutput)

        Whether the seed audience is included in the audience generation output.

        Parameters:
        includeSeedInOutput - Whether the seed audience is included in the audience generation output.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • name

        StartAudienceGenerationJobRequest.Builder name​(String name)

        The name of the audience generation job.

        Parameters:
        name - The name of the audience generation job.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        StartAudienceGenerationJobRequest.Builder tags​(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 Forecast 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.

        Parameters:
        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 Forecast 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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.