// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. package swf import ( "context" "github.com/aws/aws-sdk-go-v2/aws" "github.com/aws/aws-sdk-go-v2/internal/awsutil" ) type DescribeDomainInput struct { _ struct{} `type:"structure"` // The name of the domain to describe. // // Name is a required field Name *string `locationName:"name" min:"1" type:"string" required:"true"` } // String returns the string representation func (s DescribeDomainInput) String() string { return awsutil.Prettify(s) } // Validate inspects the fields of the type to determine if they are valid. func (s *DescribeDomainInput) Validate() error { invalidParams := aws.ErrInvalidParams{Context: "DescribeDomainInput"} if s.Name == nil { invalidParams.Add(aws.NewErrParamRequired("Name")) } if s.Name != nil && len(*s.Name) < 1 { invalidParams.Add(aws.NewErrParamMinLen("Name", 1)) } if invalidParams.Len() > 0 { return invalidParams } return nil } // Contains details of a domain. type DescribeDomainOutput struct { _ struct{} `type:"structure"` // The domain configuration. Currently, this includes only the domain's retention // period. // // Configuration is a required field Configuration *DomainConfiguration `locationName:"configuration" type:"structure" required:"true"` // The basic information about a domain, such as its name, status, and description. // // DomainInfo is a required field DomainInfo *DomainInfo `locationName:"domainInfo" type:"structure" required:"true"` } // String returns the string representation func (s DescribeDomainOutput) String() string { return awsutil.Prettify(s) } const opDescribeDomain = "DescribeDomain" // DescribeDomainRequest returns a request value for making API operation for // Amazon Simple Workflow Service. // // Returns information about the specified domain, including description and // status. // // Access Control // // You can use IAM policies to control this action's access to Amazon SWF resources // as follows: // // * Use a Resource element with the domain name to limit the action to only // specified domains. // // * Use an Action element to allow or deny permission to call this action. // // * You cannot use an IAM policy to constrain this action's parameters. // // If the caller doesn't have sufficient permissions to invoke the action, or // the parameter values fall outside the specified constraints, the action fails. // The associated event attribute's cause parameter is set to OPERATION_NOT_PERMITTED. // For details and example IAM policies, see Using IAM to Manage Access to Amazon // SWF Workflows (https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html) // in the Amazon SWF Developer Guide. // // // Example sending a request using DescribeDomainRequest. // req := client.DescribeDomainRequest(params) // resp, err := req.Send(context.TODO()) // if err == nil { // fmt.Println(resp) // } func (c *Client) DescribeDomainRequest(input *DescribeDomainInput) DescribeDomainRequest { op := &aws.Operation{ Name: opDescribeDomain, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { input = &DescribeDomainInput{} } req := c.newRequest(op, input, &DescribeDomainOutput{}) return DescribeDomainRequest{Request: req, Input: input, Copy: c.DescribeDomainRequest} } // DescribeDomainRequest is the request type for the // DescribeDomain API operation. type DescribeDomainRequest struct { *aws.Request Input *DescribeDomainInput Copy func(*DescribeDomainInput) DescribeDomainRequest } // Send marshals and sends the DescribeDomain API request. func (r DescribeDomainRequest) Send(ctx context.Context) (*DescribeDomainResponse, error) { r.Request.SetContext(ctx) err := r.Request.Send() if err != nil { return nil, err } resp := &DescribeDomainResponse{ DescribeDomainOutput: r.Request.Data.(*DescribeDomainOutput), response: &aws.Response{Request: r.Request}, } return resp, nil } // DescribeDomainResponse is the response type for the // DescribeDomain API operation. type DescribeDomainResponse struct { *DescribeDomainOutput response *aws.Response } // SDKResponseMetdata returns the response metadata for the // DescribeDomain request. func (r *DescribeDomainResponse) SDKResponseMetdata() *aws.Response { return r.response }