tokens

package
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 14, 2023 License: MIT Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client for tokens API

func (*Client) CreateRestrictedDataToken

func (a *Client) CreateRestrictedDataToken(params *CreateRestrictedDataTokenParams, opts ...ClientOption) (*CreateRestrictedDataTokenOK, error)
CreateRestrictedDataToken Returns a Restricted Data Token (RDT) for one or more restricted resources that you specify. A restricted resource is the HTTP method and path from a restricted operation that returns Personally Identifiable Information (PII), plus a dataElements value that indicates the type of PII requested. See the Tokens API Use Case Guide for a list of restricted operations. Use the RDT returned here as the access token in subsequent calls to the corresponding restricted operations.

**Usage Plan:**

| Rate (requests per second) | Burst | | ---- | ---- | | 1 | 10 |

The `x-amzn-RateLimit-Limit` response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, see [Usage Plans and Rate Limits in the Selling Partner API](https://developer-docs.amazon.com/sp-api/docs/usage-plans-and-rate-limits-in-the-sp-api).

func (*Client) SetTransport

func (a *Client) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client

type ClientOption

type ClientOption func(*runtime.ClientOperation)

ClientOption is the option for Client methods

type ClientService

type ClientService interface {
	CreateRestrictedDataToken(params *CreateRestrictedDataTokenParams, opts ...ClientOption) (*CreateRestrictedDataTokenOK, error)

	SetTransport(transport runtime.ClientTransport)
}

ClientService is the interface for Client methods

func New

func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService

New creates a new tokens API client.

type CreateRestrictedDataTokenBadRequest

type CreateRestrictedDataTokenBadRequest struct {

	/* Your rate limit (requests per second) for this operation.
	 */
	XAmznRateLimitLimit string

	/* Unique request reference identifier.
	 */
	XAmznRequestID string

	Payload *tokens_2021_03_01_models.ErrorList
}

CreateRestrictedDataTokenBadRequest describes a response with status code 400, with default header values.

Request has missing or invalid parameters and cannot be parsed.

func NewCreateRestrictedDataTokenBadRequest

func NewCreateRestrictedDataTokenBadRequest() *CreateRestrictedDataTokenBadRequest

NewCreateRestrictedDataTokenBadRequest creates a CreateRestrictedDataTokenBadRequest with default headers values

func (*CreateRestrictedDataTokenBadRequest) Error

func (*CreateRestrictedDataTokenBadRequest) GetPayload

func (*CreateRestrictedDataTokenBadRequest) IsClientError

func (o *CreateRestrictedDataTokenBadRequest) IsClientError() bool

IsClientError returns true when this create restricted data token bad request response has a 4xx status code

func (*CreateRestrictedDataTokenBadRequest) IsCode

IsCode returns true when this create restricted data token bad request response a status code equal to that given

func (*CreateRestrictedDataTokenBadRequest) IsRedirect

func (o *CreateRestrictedDataTokenBadRequest) IsRedirect() bool

IsRedirect returns true when this create restricted data token bad request response has a 3xx status code

func (*CreateRestrictedDataTokenBadRequest) IsServerError

func (o *CreateRestrictedDataTokenBadRequest) IsServerError() bool

IsServerError returns true when this create restricted data token bad request response has a 5xx status code

func (*CreateRestrictedDataTokenBadRequest) IsSuccess

IsSuccess returns true when this create restricted data token bad request response has a 2xx status code

func (*CreateRestrictedDataTokenBadRequest) String

type CreateRestrictedDataTokenForbidden

type CreateRestrictedDataTokenForbidden struct {

	/* Unique request reference identifier.
	 */
	XAmznRequestID string

	Payload *tokens_2021_03_01_models.ErrorList
}

CreateRestrictedDataTokenForbidden describes a response with status code 403, with default header values.

Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

func NewCreateRestrictedDataTokenForbidden

func NewCreateRestrictedDataTokenForbidden() *CreateRestrictedDataTokenForbidden

NewCreateRestrictedDataTokenForbidden creates a CreateRestrictedDataTokenForbidden with default headers values

func (*CreateRestrictedDataTokenForbidden) Error

func (*CreateRestrictedDataTokenForbidden) GetPayload

func (*CreateRestrictedDataTokenForbidden) IsClientError

func (o *CreateRestrictedDataTokenForbidden) IsClientError() bool

IsClientError returns true when this create restricted data token forbidden response has a 4xx status code

func (*CreateRestrictedDataTokenForbidden) IsCode

IsCode returns true when this create restricted data token forbidden response a status code equal to that given

func (*CreateRestrictedDataTokenForbidden) IsRedirect

func (o *CreateRestrictedDataTokenForbidden) IsRedirect() bool

IsRedirect returns true when this create restricted data token forbidden response has a 3xx status code

func (*CreateRestrictedDataTokenForbidden) IsServerError

func (o *CreateRestrictedDataTokenForbidden) IsServerError() bool

IsServerError returns true when this create restricted data token forbidden response has a 5xx status code

func (*CreateRestrictedDataTokenForbidden) IsSuccess

IsSuccess returns true when this create restricted data token forbidden response has a 2xx status code

func (*CreateRestrictedDataTokenForbidden) String

type CreateRestrictedDataTokenInternalServerError

type CreateRestrictedDataTokenInternalServerError struct {

	/* Your rate limit (requests per second) for this operation.
	_Note:_ For this status code, the rate limit header is deprecated and no longer returned.
	*/
	XAmznRateLimitLimit string

	/* Unique request reference identifier.
	 */
	XAmznRequestID string

	Payload *tokens_2021_03_01_models.ErrorList
}

CreateRestrictedDataTokenInternalServerError describes a response with status code 500, with default header values.

An unexpected condition occurred that prevented the server from fulfilling the request.

func NewCreateRestrictedDataTokenInternalServerError

func NewCreateRestrictedDataTokenInternalServerError() *CreateRestrictedDataTokenInternalServerError

NewCreateRestrictedDataTokenInternalServerError creates a CreateRestrictedDataTokenInternalServerError with default headers values

func (*CreateRestrictedDataTokenInternalServerError) Error

func (*CreateRestrictedDataTokenInternalServerError) GetPayload

func (*CreateRestrictedDataTokenInternalServerError) IsClientError

IsClientError returns true when this create restricted data token internal server error response has a 4xx status code

func (*CreateRestrictedDataTokenInternalServerError) IsCode

IsCode returns true when this create restricted data token internal server error response a status code equal to that given

func (*CreateRestrictedDataTokenInternalServerError) IsRedirect

IsRedirect returns true when this create restricted data token internal server error response has a 3xx status code

func (*CreateRestrictedDataTokenInternalServerError) IsServerError

IsServerError returns true when this create restricted data token internal server error response has a 5xx status code

func (*CreateRestrictedDataTokenInternalServerError) IsSuccess

IsSuccess returns true when this create restricted data token internal server error response has a 2xx status code

func (*CreateRestrictedDataTokenInternalServerError) String

type CreateRestrictedDataTokenNotFound

type CreateRestrictedDataTokenNotFound struct {

	/* Your rate limit (requests per second) for this operation.
	 */
	XAmznRateLimitLimit string

	/* Unique request reference identifier.
	 */
	XAmznRequestID string

	Payload *tokens_2021_03_01_models.ErrorList
}

CreateRestrictedDataTokenNotFound describes a response with status code 404, with default header values.

The specified resource does not exist.

func NewCreateRestrictedDataTokenNotFound

func NewCreateRestrictedDataTokenNotFound() *CreateRestrictedDataTokenNotFound

NewCreateRestrictedDataTokenNotFound creates a CreateRestrictedDataTokenNotFound with default headers values

func (*CreateRestrictedDataTokenNotFound) Error

func (*CreateRestrictedDataTokenNotFound) GetPayload

func (*CreateRestrictedDataTokenNotFound) IsClientError

func (o *CreateRestrictedDataTokenNotFound) IsClientError() bool

IsClientError returns true when this create restricted data token not found response has a 4xx status code

func (*CreateRestrictedDataTokenNotFound) IsCode

func (o *CreateRestrictedDataTokenNotFound) IsCode(code int) bool

IsCode returns true when this create restricted data token not found response a status code equal to that given

func (*CreateRestrictedDataTokenNotFound) IsRedirect

func (o *CreateRestrictedDataTokenNotFound) IsRedirect() bool

IsRedirect returns true when this create restricted data token not found response has a 3xx status code

func (*CreateRestrictedDataTokenNotFound) IsServerError

func (o *CreateRestrictedDataTokenNotFound) IsServerError() bool

IsServerError returns true when this create restricted data token not found response has a 5xx status code

func (*CreateRestrictedDataTokenNotFound) IsSuccess

func (o *CreateRestrictedDataTokenNotFound) IsSuccess() bool

IsSuccess returns true when this create restricted data token not found response has a 2xx status code

func (*CreateRestrictedDataTokenNotFound) String

type CreateRestrictedDataTokenOK

type CreateRestrictedDataTokenOK struct {

	/* Your rate limit (requests per second) for this operation.
	 */
	XAmznRateLimitLimit string

	/* Unique request reference identifier.
	 */
	XAmznRequestID string

	Payload *tokens_2021_03_01_models.CreateRestrictedDataTokenResponse
}

CreateRestrictedDataTokenOK describes a response with status code 200, with default header values.

Success.

func NewCreateRestrictedDataTokenOK

func NewCreateRestrictedDataTokenOK() *CreateRestrictedDataTokenOK

NewCreateRestrictedDataTokenOK creates a CreateRestrictedDataTokenOK with default headers values

func (*CreateRestrictedDataTokenOK) Error

func (*CreateRestrictedDataTokenOK) GetPayload

func (*CreateRestrictedDataTokenOK) IsClientError

func (o *CreateRestrictedDataTokenOK) IsClientError() bool

IsClientError returns true when this create restricted data token o k response has a 4xx status code

func (*CreateRestrictedDataTokenOK) IsCode

func (o *CreateRestrictedDataTokenOK) IsCode(code int) bool

IsCode returns true when this create restricted data token o k response a status code equal to that given

func (*CreateRestrictedDataTokenOK) IsRedirect

func (o *CreateRestrictedDataTokenOK) IsRedirect() bool

IsRedirect returns true when this create restricted data token o k response has a 3xx status code

func (*CreateRestrictedDataTokenOK) IsServerError

func (o *CreateRestrictedDataTokenOK) IsServerError() bool

IsServerError returns true when this create restricted data token o k response has a 5xx status code

func (*CreateRestrictedDataTokenOK) IsSuccess

func (o *CreateRestrictedDataTokenOK) IsSuccess() bool

IsSuccess returns true when this create restricted data token o k response has a 2xx status code

func (*CreateRestrictedDataTokenOK) String

func (o *CreateRestrictedDataTokenOK) String() string

type CreateRestrictedDataTokenParams

type CreateRestrictedDataTokenParams struct {

	/* Body.

	   The restricted data token request details.
	*/
	Body *tokens_2021_03_01_models.CreateRestrictedDataTokenRequest

	Context    context.Context
	HTTPClient *http.Client
	// contains filtered or unexported fields
}

CreateRestrictedDataTokenParams contains all the parameters to send to the API endpoint

for the create restricted data token operation.

Typically these are written to a http.Request.

func NewCreateRestrictedDataTokenParams

func NewCreateRestrictedDataTokenParams() *CreateRestrictedDataTokenParams

NewCreateRestrictedDataTokenParams creates a new CreateRestrictedDataTokenParams object, with the default timeout for this client.

Default values are not hydrated, since defaults are normally applied by the API server side.

To enforce default values in parameter, use SetDefaults or WithDefaults.

func NewCreateRestrictedDataTokenParamsWithContext

func NewCreateRestrictedDataTokenParamsWithContext(ctx context.Context) *CreateRestrictedDataTokenParams

NewCreateRestrictedDataTokenParamsWithContext creates a new CreateRestrictedDataTokenParams object with the ability to set a context for a request.

func NewCreateRestrictedDataTokenParamsWithHTTPClient

func NewCreateRestrictedDataTokenParamsWithHTTPClient(client *http.Client) *CreateRestrictedDataTokenParams

NewCreateRestrictedDataTokenParamsWithHTTPClient creates a new CreateRestrictedDataTokenParams object with the ability to set a custom HTTPClient for a request.

func NewCreateRestrictedDataTokenParamsWithTimeout

func NewCreateRestrictedDataTokenParamsWithTimeout(timeout time.Duration) *CreateRestrictedDataTokenParams

NewCreateRestrictedDataTokenParamsWithTimeout creates a new CreateRestrictedDataTokenParams object with the ability to set a timeout on a request.

func (*CreateRestrictedDataTokenParams) SetBody

SetBody adds the body to the create restricted data token params

func (*CreateRestrictedDataTokenParams) SetContext

func (o *CreateRestrictedDataTokenParams) SetContext(ctx context.Context)

SetContext adds the context to the create restricted data token params

func (*CreateRestrictedDataTokenParams) SetDefaults

func (o *CreateRestrictedDataTokenParams) SetDefaults()

SetDefaults hydrates default values in the create restricted data token params (not the query body).

All values with no default are reset to their zero value.

func (*CreateRestrictedDataTokenParams) SetHTTPClient

func (o *CreateRestrictedDataTokenParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the create restricted data token params

func (*CreateRestrictedDataTokenParams) SetTimeout

func (o *CreateRestrictedDataTokenParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the create restricted data token params

func (*CreateRestrictedDataTokenParams) WithBody

WithBody adds the body to the create restricted data token params

func (*CreateRestrictedDataTokenParams) WithContext

WithContext adds the context to the create restricted data token params

func (*CreateRestrictedDataTokenParams) WithDefaults

WithDefaults hydrates default values in the create restricted data token params (not the query body).

All values with no default are reset to their zero value.

func (*CreateRestrictedDataTokenParams) WithHTTPClient

WithHTTPClient adds the HTTPClient to the create restricted data token params

func (*CreateRestrictedDataTokenParams) WithTimeout

WithTimeout adds the timeout to the create restricted data token params

func (*CreateRestrictedDataTokenParams) WriteToRequest

WriteToRequest writes these params to a swagger request

type CreateRestrictedDataTokenReader

type CreateRestrictedDataTokenReader struct {
	// contains filtered or unexported fields
}

CreateRestrictedDataTokenReader is a Reader for the CreateRestrictedDataToken structure.

func (*CreateRestrictedDataTokenReader) ReadResponse

func (o *CreateRestrictedDataTokenReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type CreateRestrictedDataTokenServiceUnavailable

type CreateRestrictedDataTokenServiceUnavailable struct {

	/* Your rate limit (requests per second) for this operation.
	_Note:_ For this status code, the rate limit header is deprecated and no longer returned.
	*/
	XAmznRateLimitLimit string

	/* Unique request reference identifier.
	 */
	XAmznRequestID string

	Payload *tokens_2021_03_01_models.ErrorList
}

CreateRestrictedDataTokenServiceUnavailable describes a response with status code 503, with default header values.

Temporary overloading or maintenance of the server.

func NewCreateRestrictedDataTokenServiceUnavailable

func NewCreateRestrictedDataTokenServiceUnavailable() *CreateRestrictedDataTokenServiceUnavailable

NewCreateRestrictedDataTokenServiceUnavailable creates a CreateRestrictedDataTokenServiceUnavailable with default headers values

func (*CreateRestrictedDataTokenServiceUnavailable) Error

func (*CreateRestrictedDataTokenServiceUnavailable) GetPayload

func (*CreateRestrictedDataTokenServiceUnavailable) IsClientError

IsClientError returns true when this create restricted data token service unavailable response has a 4xx status code

func (*CreateRestrictedDataTokenServiceUnavailable) IsCode

IsCode returns true when this create restricted data token service unavailable response a status code equal to that given

func (*CreateRestrictedDataTokenServiceUnavailable) IsRedirect

IsRedirect returns true when this create restricted data token service unavailable response has a 3xx status code

func (*CreateRestrictedDataTokenServiceUnavailable) IsServerError

IsServerError returns true when this create restricted data token service unavailable response has a 5xx status code

func (*CreateRestrictedDataTokenServiceUnavailable) IsSuccess

IsSuccess returns true when this create restricted data token service unavailable response has a 2xx status code

func (*CreateRestrictedDataTokenServiceUnavailable) String

type CreateRestrictedDataTokenTooManyRequests

type CreateRestrictedDataTokenTooManyRequests struct {

	/* Your rate limit (requests per second) for this operation.
	_Note:_ For this status code, the rate limit header is deprecated and no longer returned.
	*/
	XAmznRateLimitLimit string

	/* Unique request reference identifier.
	 */
	XAmznRequestID string

	Payload *tokens_2021_03_01_models.ErrorList
}

CreateRestrictedDataTokenTooManyRequests describes a response with status code 429, with default header values.

The frequency of requests was greater than allowed.

func NewCreateRestrictedDataTokenTooManyRequests

func NewCreateRestrictedDataTokenTooManyRequests() *CreateRestrictedDataTokenTooManyRequests

NewCreateRestrictedDataTokenTooManyRequests creates a CreateRestrictedDataTokenTooManyRequests with default headers values

func (*CreateRestrictedDataTokenTooManyRequests) Error

func (*CreateRestrictedDataTokenTooManyRequests) GetPayload

func (*CreateRestrictedDataTokenTooManyRequests) IsClientError

IsClientError returns true when this create restricted data token too many requests response has a 4xx status code

func (*CreateRestrictedDataTokenTooManyRequests) IsCode

IsCode returns true when this create restricted data token too many requests response a status code equal to that given

func (*CreateRestrictedDataTokenTooManyRequests) IsRedirect

IsRedirect returns true when this create restricted data token too many requests response has a 3xx status code

func (*CreateRestrictedDataTokenTooManyRequests) IsServerError

IsServerError returns true when this create restricted data token too many requests response has a 5xx status code

func (*CreateRestrictedDataTokenTooManyRequests) IsSuccess

IsSuccess returns true when this create restricted data token too many requests response has a 2xx status code

func (*CreateRestrictedDataTokenTooManyRequests) String

type CreateRestrictedDataTokenUnauthorized

type CreateRestrictedDataTokenUnauthorized struct {

	/* Unique request reference identifier.
	 */
	XAmznRequestID string

	Payload *tokens_2021_03_01_models.ErrorList
}

CreateRestrictedDataTokenUnauthorized describes a response with status code 401, with default header values.

The request's Authorization header is not formatted correctly or does not contain a valid token.

func NewCreateRestrictedDataTokenUnauthorized

func NewCreateRestrictedDataTokenUnauthorized() *CreateRestrictedDataTokenUnauthorized

NewCreateRestrictedDataTokenUnauthorized creates a CreateRestrictedDataTokenUnauthorized with default headers values

func (*CreateRestrictedDataTokenUnauthorized) Error

func (*CreateRestrictedDataTokenUnauthorized) GetPayload

func (*CreateRestrictedDataTokenUnauthorized) IsClientError

func (o *CreateRestrictedDataTokenUnauthorized) IsClientError() bool

IsClientError returns true when this create restricted data token unauthorized response has a 4xx status code

func (*CreateRestrictedDataTokenUnauthorized) IsCode

IsCode returns true when this create restricted data token unauthorized response a status code equal to that given

func (*CreateRestrictedDataTokenUnauthorized) IsRedirect

IsRedirect returns true when this create restricted data token unauthorized response has a 3xx status code

func (*CreateRestrictedDataTokenUnauthorized) IsServerError

func (o *CreateRestrictedDataTokenUnauthorized) IsServerError() bool

IsServerError returns true when this create restricted data token unauthorized response has a 5xx status code

func (*CreateRestrictedDataTokenUnauthorized) IsSuccess

IsSuccess returns true when this create restricted data token unauthorized response has a 2xx status code

func (*CreateRestrictedDataTokenUnauthorized) String

type CreateRestrictedDataTokenUnsupportedMediaType

type CreateRestrictedDataTokenUnsupportedMediaType struct {

	/* Your rate limit (requests per second) for this operation.
	_Note:_ For this status code, the rate limit header is deprecated and no longer returned.
	*/
	XAmznRateLimitLimit string

	/* Unique request reference identifier.
	 */
	XAmznRequestID string

	Payload *tokens_2021_03_01_models.ErrorList
}

CreateRestrictedDataTokenUnsupportedMediaType describes a response with status code 415, with default header values.

The request payload is in an unsupported format.

func NewCreateRestrictedDataTokenUnsupportedMediaType

func NewCreateRestrictedDataTokenUnsupportedMediaType() *CreateRestrictedDataTokenUnsupportedMediaType

NewCreateRestrictedDataTokenUnsupportedMediaType creates a CreateRestrictedDataTokenUnsupportedMediaType with default headers values

func (*CreateRestrictedDataTokenUnsupportedMediaType) Error

func (*CreateRestrictedDataTokenUnsupportedMediaType) GetPayload

func (*CreateRestrictedDataTokenUnsupportedMediaType) IsClientError

IsClientError returns true when this create restricted data token unsupported media type response has a 4xx status code

func (*CreateRestrictedDataTokenUnsupportedMediaType) IsCode

IsCode returns true when this create restricted data token unsupported media type response a status code equal to that given

func (*CreateRestrictedDataTokenUnsupportedMediaType) IsRedirect

IsRedirect returns true when this create restricted data token unsupported media type response has a 3xx status code

func (*CreateRestrictedDataTokenUnsupportedMediaType) IsServerError

IsServerError returns true when this create restricted data token unsupported media type response has a 5xx status code

func (*CreateRestrictedDataTokenUnsupportedMediaType) IsSuccess

IsSuccess returns true when this create restricted data token unsupported media type response has a 2xx status code

func (*CreateRestrictedDataTokenUnsupportedMediaType) String

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL