/
api_op_CreatePresignedNotebookInstanceUrl.go
145 lines (120 loc) · 5.46 KB
/
api_op_CreatePresignedNotebookInstanceUrl.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT.
package sagemaker
import (
"context"
"github.com/aws/aws-sdk-go-v2/aws"
"github.com/aws/aws-sdk-go-v2/internal/awsutil"
)
type CreatePresignedNotebookInstanceUrlInput struct {
_ struct{} `type:"structure"`
// The name of the notebook instance.
//
// NotebookInstanceName is a required field
NotebookInstanceName *string `type:"string" required:"true"`
// The duration of the session, in seconds. The default is 12 hours.
SessionExpirationDurationInSeconds *int64 `min:"1800" type:"integer"`
}
// String returns the string representation
func (s CreatePresignedNotebookInstanceUrlInput) String() string {
return awsutil.Prettify(s)
}
// Validate inspects the fields of the type to determine if they are valid.
func (s *CreatePresignedNotebookInstanceUrlInput) Validate() error {
invalidParams := aws.ErrInvalidParams{Context: "CreatePresignedNotebookInstanceUrlInput"}
if s.NotebookInstanceName == nil {
invalidParams.Add(aws.NewErrParamRequired("NotebookInstanceName"))
}
if s.SessionExpirationDurationInSeconds != nil && *s.SessionExpirationDurationInSeconds < 1800 {
invalidParams.Add(aws.NewErrParamMinValue("SessionExpirationDurationInSeconds", 1800))
}
if invalidParams.Len() > 0 {
return invalidParams
}
return nil
}
type CreatePresignedNotebookInstanceUrlOutput struct {
_ struct{} `type:"structure"`
// A JSON object that contains the URL string.
AuthorizedUrl *string `type:"string"`
}
// String returns the string representation
func (s CreatePresignedNotebookInstanceUrlOutput) String() string {
return awsutil.Prettify(s)
}
const opCreatePresignedNotebookInstanceUrl = "CreatePresignedNotebookInstanceUrl"
// CreatePresignedNotebookInstanceUrlRequest returns a request value for making API operation for
// Amazon SageMaker Service.
//
// Returns a URL that you can use to connect to the Jupyter server from a notebook
// instance. In the Amazon SageMaker console, when you choose Open next to a
// notebook instance, Amazon SageMaker opens a new tab showing the Jupyter server
// home page from the notebook instance. The console uses this API to get the
// URL and show the page.
//
// The IAM role or user used to call this API defines the permissions to access
// the notebook instance. Once the presigned URL is created, no additional permission
// is required to access this URL. IAM authorization policies for this API are
// also enforced for every HTTP request and WebSocket frame that attempts to
// connect to the notebook instance.
//
// You can restrict access to this API and to the URL that it returns to a list
// of IP addresses that you specify. Use the NotIpAddress condition operator
// and the aws:SourceIP condition context key to specify the list of IP addresses
// that you want to have access to the notebook instance. For more information,
// see Limit Access to a Notebook Instance by IP Address (https://docs.aws.amazon.com/sagemaker/latest/dg/security_iam_id-based-policy-examples.html#nbi-ip-filter).
//
// The URL that you get from a call to CreatePresignedNotebookInstanceUrl is
// valid only for 5 minutes. If you try to use the URL after the 5-minute limit
// expires, you are directed to the AWS console sign-in page.
//
// // Example sending a request using CreatePresignedNotebookInstanceUrlRequest.
// req := client.CreatePresignedNotebookInstanceUrlRequest(params)
// resp, err := req.Send(context.TODO())
// if err == nil {
// fmt.Println(resp)
// }
//
// Please also see https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/CreatePresignedNotebookInstanceUrl
func (c *Client) CreatePresignedNotebookInstanceUrlRequest(input *CreatePresignedNotebookInstanceUrlInput) CreatePresignedNotebookInstanceUrlRequest {
op := &aws.Operation{
Name: opCreatePresignedNotebookInstanceUrl,
HTTPMethod: "POST",
HTTPPath: "/",
}
if input == nil {
input = &CreatePresignedNotebookInstanceUrlInput{}
}
req := c.newRequest(op, input, &CreatePresignedNotebookInstanceUrlOutput{})
return CreatePresignedNotebookInstanceUrlRequest{Request: req, Input: input, Copy: c.CreatePresignedNotebookInstanceUrlRequest}
}
// CreatePresignedNotebookInstanceUrlRequest is the request type for the
// CreatePresignedNotebookInstanceUrl API operation.
type CreatePresignedNotebookInstanceUrlRequest struct {
*aws.Request
Input *CreatePresignedNotebookInstanceUrlInput
Copy func(*CreatePresignedNotebookInstanceUrlInput) CreatePresignedNotebookInstanceUrlRequest
}
// Send marshals and sends the CreatePresignedNotebookInstanceUrl API request.
func (r CreatePresignedNotebookInstanceUrlRequest) Send(ctx context.Context) (*CreatePresignedNotebookInstanceUrlResponse, error) {
r.Request.SetContext(ctx)
err := r.Request.Send()
if err != nil {
return nil, err
}
resp := &CreatePresignedNotebookInstanceUrlResponse{
CreatePresignedNotebookInstanceUrlOutput: r.Request.Data.(*CreatePresignedNotebookInstanceUrlOutput),
response: &aws.Response{Request: r.Request},
}
return resp, nil
}
// CreatePresignedNotebookInstanceUrlResponse is the response type for the
// CreatePresignedNotebookInstanceUrl API operation.
type CreatePresignedNotebookInstanceUrlResponse struct {
*CreatePresignedNotebookInstanceUrlOutput
response *aws.Response
}
// SDKResponseMetdata returns the response metadata for the
// CreatePresignedNotebookInstanceUrl request.
func (r *CreatePresignedNotebookInstanceUrlResponse) SDKResponseMetdata() *aws.Response {
return r.response
}