Skip to content

get_programmatic_access_credentials

get_programmatic_access_credentials(
    environment_id: IdType,
    *,
    config_overrides: Optional[finspacedataClientConfig] = None,
    duration_in_minutes: Optional[SessionDuration] = None,
) -> GetProgrammaticAccessCredentialsResponse

Request programmatic credentials to use with FinSpace SDK. For more information, see Step 2. Access credentials programmatically using IAM access key id and secret access key.

Parameters:

  • duration_in_minutes (Optional[SessionDuration], default: None ) –

    The time duration in which the credentials remain valid.

  • environment_id (IdType) –

    The FinSpace environment identifier.

Raises:

Source code in docs_src/capo_finspace_data/_services/finspacedata.py
def get_programmatic_access_credentials(
    self,
    environment_id: "capo_finspace_data.types.id_type.IdType",
    *,
    config_overrides: Optional[finspacedataClientConfig] = None,
    duration_in_minutes: Optional[
        "capo_finspace_data.types.session_duration.SessionDuration"
    ] = None,
) -> "capo_finspace_data.types.get_programmatic_access_credentials_response.GetProgrammaticAccessCredentialsResponse":
    """<p>Request programmatic credentials to use with FinSpace SDK. For more information, see <a href="https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#accessing-credentials">Step 2. Access credentials programmatically using IAM access key id and secret access key</a>.</p>

    Args:
        duration_in_minutes: <p>The time duration in which the credentials remain valid. </p>
        environment_id: <p>The FinSpace environment identifier.</p>

    Raises:
        capo_finspace_data.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_finspace_data.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_finspace_data.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_finspace_data.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an AWS service.</p>
        capo_finspace_data.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_finspace_data.types.get_programmatic_access_credentials_request.GetProgrammaticAccessCredentialsRequest]",
    ) -> OperationResponse[
        "capo_finspace_data.types.get_programmatic_access_credentials_response.GetProgrammaticAccessCredentialsResponse"
    ]:
        import capo_finspace_data._operations.aws_habanero_public_api.get_programmatic_access_credentials

        output, http_response = (
            capo_finspace_data._operations.aws_habanero_public_api.get_programmatic_access_credentials.get_programmatic_access_credentials(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_finspace_data.types.get_programmatic_access_credentials_response.GetProgrammaticAccessCredentialsResponse",
    ) -> dict[str, Any]:
        import capo_finspace_data.types.get_programmatic_access_credentials_response

        return capo_finspace_data.types.get_programmatic_access_credentials_response.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "GetProgrammaticAccessCredentials", redact_output=_redact_output
        ),
    )
    input_: capo_finspace_data.types.get_programmatic_access_credentials_request.GetProgrammaticAccessCredentialsRequest = {
        "environment_id": environment_id
    }
    if duration_in_minutes is not None:
        input_["duration_in_minutes"] = duration_in_minutes

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