create_predefined_attribute ¶

def create_predefined_attribute(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    name: "capo_connect.types.predefined_attribute_name.PredefinedAttributeName",
    *,
    config_overrides: Optional[ConnectClientConfig] = None,
    values: Optional[
        "capo_connect.types.predefined_attribute_values.PredefinedAttributeValues"
    ] = None,
    purposes: Optional[
        "capo_connect.types.predefined_attribute_purpose_name_list.PredefinedAttributePurposeNameList"
    ] = None,
    attribute_configuration: Optional[
        "capo_connect.types.input_predefined_attribute_configuration.InputPredefinedAttributeConfiguration"
    ] = None,
) -> None:
    """<p>Creates a new predefined attribute for the specified Connect Customer instance. A <i>predefined attribute</i> is made up of a name and a value.</p> <p>For the predefined attributes per instance quota, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas">Connect Customer quotas</a>.</p> <p> <b>Use cases</b> </p> <p>Following are common uses cases for this API:</p> <ul> <li> <p>Create an attribute for routing proficiency (for example, agent certification) that has predefined values (for example, a list of possible certifications). For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html">Create predefined attributes for routing contacts to agents</a>.</p> </li> <li> <p>Create an attribute for business unit name that has a list of predefined business unit names used in your organization. This is a use case where information for a contact varies between transfers or conferences. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html">Use contact segment attributes</a>.</p> </li> </ul> <p> <b>Endpoints</b>: See <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Connect Customer endpoints and quotas</a>.</p>

    Args:
        instance_id: <p>The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</p>
        name: <p> The name of the predefined attribute. </p>
        values: <p> The values of the predefined attribute. </p>
        purposes: <p>Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Connect Customer admin website.</p>
        attribute_configuration: <p>Custom metadata that is associated to predefined attributes to control behavior in upstream services, such as controlling how a predefined attribute should be displayed in the Connect Customer admin website.</p>

    Raises:
        capo_connect.errors.duplicate_resource_exception.DuplicateResourceException: <p>A resource with the specified name already exists.</p>
        capo_connect.errors.internal_service_exception.InternalServiceException: <p>Request processing failed because of an error or failure with the service.</p>
        capo_connect.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more of the specified parameters are not valid.</p>
        capo_connect.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_connect.errors.limit_exceeded_exception.LimitExceededException: <p>The allowed limit for the resource has been exceeded.</p>
        capo_connect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_connect.errors.throttling_exception.ThrottlingException: <p>The throttling limit has been exceeded.</p>
        capo_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_connect.types.create_predefined_attribute_request.CreatePredefinedAttributeRequest]",
    ) -> OperationResponse[None]:
        import capo_connect._operations.amazon_connect_service.create_predefined_attribute

        output, http_response = (
            capo_connect._operations.amazon_connect_service.create_predefined_attribute.create_predefined_attribute(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreatePredefinedAttribute")
    )
    input_: capo_connect.types.create_predefined_attribute_request.CreatePredefinedAttributeRequest = {
        "instance_id": instance_id,
        "name": name,
    }
    if values is not None:
        input_["values"] = values
    if purposes is not None:
        input_["purposes"] = purposes
    if attribute_configuration is not None:
        input_["attribute_configuration"] = attribute_configuration

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output