Skip to content

create_group_profile

create_group_profile(
    domain_identifier: DomainId,
    *,
    config_overrides: Optional[DataZoneClientConfig] = None,
    group_identifier: Optional[GroupIdentifier] = None,
    role_principal_arn: Optional[str] = None,
    client_token: Optional[str] = None,
) -> CreateGroupProfileOutput

Creates a group profile in Amazon DataZone.

Parameters:

  • domain_identifier (DomainId) –

    The identifier of the Amazon DataZone domain in which the group profile is created.

  • group_identifier (Optional[GroupIdentifier], default: None ) –

    The identifier of the group for which the group profile is created.

  • role_principal_arn (Optional[str], default: None ) –

    The ARN of the IAM role that will be associated with the group profile. This role defines the permissions that group members will assume when accessing Amazon DataZone resources.

  • client_token (Optional[str], default: None ) –

    A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.

Raises:

Source code in docs_src/capo_datazone/_services/data_zone.py
def create_group_profile(
    self,
    domain_identifier: "capo_datazone.types.domain_id.DomainId",
    *,
    config_overrides: Optional[DataZoneClientConfig] = None,
    group_identifier: Optional[
        "capo_datazone.types.group_identifier.GroupIdentifier"
    ] = None,
    role_principal_arn: Optional[str] = None,
    client_token: Optional[str] = None,
) -> "capo_datazone.types.create_group_profile_output.CreateGroupProfileOutput":
    """<p>Creates a group profile in Amazon DataZone.</p>

    Args:
        domain_identifier: <p>The identifier of the Amazon DataZone domain in which the group profile is created.</p>
        group_identifier: <p>The identifier of the group for which the group profile is created.</p>
        role_principal_arn: <p>The ARN of the IAM role that will be associated with the group profile. This role defines the permissions that group members will assume when accessing Amazon DataZone resources.</p>
        client_token: <p> A unique, case-sensitive identifier that is provided to ensure the idempotency of the request.</p>

    Raises:
        capo_datazone.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_datazone.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_datazone.errors.unauthorized_exception.UnauthorizedException: <p>You do not have permission to perform this action.</p>
        capo_datazone.errors.internal_server_exception.InternalServerException: <p>The request has failed because of an unknown error, exception or failure.</p>
        capo_datazone.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource cannot be found.</p>
        capo_datazone.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the Amazon Web Services service.</p>
        capo_datazone.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_datazone.types.create_group_profile_input.CreateGroupProfileInput]",
    ) -> OperationResponse[
        "capo_datazone.types.create_group_profile_output.CreateGroupProfileOutput"
    ]:
        import capo_datazone._operations.data_zone.create_group_profile

        output, http_response = (
            capo_datazone._operations.data_zone.create_group_profile.create_group_profile(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_datazone.types.create_group_profile_output.CreateGroupProfileOutput",
    ) -> dict[str, Any]:
        import capo_datazone.types.create_group_profile_output

        return capo_datazone.types.create_group_profile_output.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CreateGroupProfile", redact_output=_redact_output),
    )
    input_: capo_datazone.types.create_group_profile_input.CreateGroupProfileInput = {
        "domain_identifier": domain_identifier
    }
    if group_identifier is not None:
        input_["group_identifier"] = group_identifier
    if role_principal_arn is not None:
        input_["role_principal_arn"] = role_principal_arn
    if client_token is None:
        client_token = str(uuid.uuid4())
    input_["client_token"] = client_token

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