Skip to content

create_profile

create_profile(
    *,
    config_overrides: Optional[WellArchitectedClientConfig] = None,
    profile_name: Optional[ProfileName] = None,
    profile_description: Optional[ProfileDescription] = None,
    profile_questions: Optional[ProfileQuestionUpdates] = None,
    client_request_token: Optional[ClientRequestToken] = None,
    tags: Optional[TagMap] = None,
) -> CreateProfileOutput

Create a profile.

Parameters:

Raises:

Source code in docs_src/capo_wellarchitected/_services/well_architected.py
def create_profile(
    self,
    *,
    config_overrides: Optional[WellArchitectedClientConfig] = None,
    profile_name: Optional[
        "capo_wellarchitected.types.profile_name.ProfileName"
    ] = None,
    profile_description: Optional[
        "capo_wellarchitected.types.profile_description.ProfileDescription"
    ] = None,
    profile_questions: Optional[
        "capo_wellarchitected.types.profile_question_updates.ProfileQuestionUpdates"
    ] = None,
    client_request_token: Optional[
        "capo_wellarchitected.types.client_request_token.ClientRequestToken"
    ] = None,
    tags: Optional["capo_wellarchitected.types.tag_map.TagMap"] = None,
) -> "capo_wellarchitected.types.create_profile_output.CreateProfileOutput":
    """<p>Create a profile.</p>

    Args:
        profile_name: <p>Name of the profile.</p>
        profile_description: <p>The profile description.</p>
        profile_questions: <p>The profile questions.</p>
        tags: <p>The tags assigned to the profile.</p>

    Raises:
        capo_wellarchitected.errors.access_denied_exception.AccessDeniedException: <p>User does not have sufficient access to perform this action.</p>
        capo_wellarchitected.errors.conflict_exception.ConflictException: <p>The resource has already been processed, was deleted, or is too large.</p>
        capo_wellarchitected.errors.internal_server_exception.InternalServerException: <p>There is a problem with the Well-Architected Tool API service.</p>
        capo_wellarchitected.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The user has reached their resource quota.</p>
        capo_wellarchitected.errors.throttling_exception.ThrottlingException: <p>Request was denied due to request throttling.</p>
        capo_wellarchitected.errors.validation_exception.ValidationException: <p>The user input is not valid.</p>
        capo_wellarchitected.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_wellarchitected.types.create_profile_input.CreateProfileInput]",
    ) -> OperationResponse[
        "capo_wellarchitected.types.create_profile_output.CreateProfileOutput"
    ]:
        import capo_wellarchitected._operations.well_architected_api_service_lambda.create_profile

        output, http_response = (
            capo_wellarchitected._operations.well_architected_api_service_lambda.create_profile.create_profile(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateProfile")
    )
    input_: capo_wellarchitected.types.create_profile_input.CreateProfileInput = {}
    if profile_name is not None:
        input_["profile_name"] = profile_name
    if profile_description is not None:
        input_["profile_description"] = profile_description
    if profile_questions is not None:
        input_["profile_questions"] = profile_questions
    if client_request_token is None:
        client_request_token = str(uuid.uuid4())
    input_["client_request_token"] = client_request_token
    if tags is not None:
        input_["tags"] = tags

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